Class aaa:SamlProvider (CONCRETE)

Class ID:10637
Class Label: SAML Provider
Encrypted: true - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model - APIC NX Processing: Disabled
Write Access: [aaa, admin]
Read Access: [aaa, admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

NO COMMENTS

Naming Rules
RN FORMAT: samlprovider-{name}

    [1] PREFIX=samlprovider- PROPERTY = name




DN FORMAT: 

[1] uni/userext/samlext/samlprovider-{name}

                


Diagram

Super Mo: aaa:AProvider,
Container Mos: aaa:SamlEp (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations To: fv:AREpP, fv:ATg,
Relations: aaa:RsProvToEpp, aaa:RsSecProvToEpg,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] aaa:UserEp A user endpoint is a local user. A user is assigned a role determines the user's privileges, and belongs to a security domain, which determines the user's scope of control
 
 
 
 
 
 
 
 ├
[V] aaa:SamlEp 
 
 
 
 
 
 
 
 
 ├
[V] aaa:SamlProvider 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] aaa:UserEp A user endpoint is a local user. A user is assigned a role determines the user's privileges, and belongs to a security domain, which determines the user's scope of control
 
 
 ├
[V] aaa:SamlEp 
 
 
 
 ├
[V] aaa:SamlProvider 


Contained Hierarchy
[V] aaa:SamlProvider 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 ├
[V] aaa:RsProvToEpp 
 ├
[V] aaa:RsSecProvToEpg A source relation to the endpoint group through which the provider server is reachable.
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Def Represents self-contained policy document.
 
 
 ├
[V] aaa:Definition The AAA policy definition. This is an abstract class and cannot be instantiated.
 
 
 
 ├
[V] aaa:AProvider An abstract class that is the superclass for the Radius/Tacacs/Ldap provider classes.
 
 
 
 
 ├
[V] aaa:SamlProvider 


Events
                aaa:SamlProvider:creation__aaa_SamlProvider
aaa:SamlProvider:modification__aaa_SamlProvider
aaa:SamlProvider:deletion__aaa_SamlProvider


Faults
                aaa:SamlProvider:SamlProvider_Inoperable
aaa:SamlProvider:SamlProviderInoperable


Fsms
                


Properties Summary
Defined in: aaa:SamlProvider
mo:Annotation
          string:Basic
annotation  (aaa:SamlProvider:annotation)
           NO COMMENTS
string:Basic entityId  (aaa:SamlProvider:entityId)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (aaa:SamlProvider:extMngdBy)
           NO COMMENTS
aaa:BannerMsg
          string:CharBuffer
guiBannerMessage  (aaa:SamlProvider:guiBannerMessage)
           NO COMMENTS
os:Hostname
          string:Basic
httpsProxy  (aaa:SamlProvider:httpsProxy)
           NO COMMENTS
aaa:IdP
          scalar:Enum8
idP  (aaa:SamlProvider:idP)
           NO COMMENTS
aaa:MetadataUrl
          string:Basic
metadataUrl  (aaa:SamlProvider:metadataUrl)
           NO COMMENTS
reference:BinRef monPolDn  (aaa:SamlProvider:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (aaa:SamlProvider:name)
           Overrides:aaa:AProvider:name | aaa:Definition:name | pol:Obj:name | naming:NamedObject:name
           The name of the object.
aaa:SigAlg
          scalar:Enum8
sigAlg  (aaa:SamlProvider:sigAlg)
           NO COMMENTS
aaa:TimeSec
          scalar:Uint32
timeout  (aaa:SamlProvider:timeout)
           Overrides:aaa:AProvider:timeout
           The amount of time between authentication attempts.
naming:Name
          string:Basic
tp  (aaa:SamlProvider:tp)
           NO COMMENTS
scalar:Bool wantAssertionsEncrypted  (aaa:SamlProvider:wantAssertionsEncrypted)
           NO COMMENTS
scalar:Bool wantAssertionsSigned  (aaa:SamlProvider:wantAssertionsSigned)
           NO COMMENTS
scalar:Bool wantRequestsSigned  (aaa:SamlProvider:wantRequestsSigned)
           NO COMMENTS
scalar:Bool wantResponseSigned  (aaa:SamlProvider:wantResponseSigned)
           NO COMMENTS
Defined in: aaa:AProvider
reference:BinRef epgDn  (aaa:AProvider:epgDn)
           Management EpG dn
aaa:Key
          string:Password
key  (aaa:AProvider:key)
           A password for the AAA provider database.
aaa:MonitorServerType
          scalar:Enum8
monitorServer  (aaa:AProvider:monitorServer)
          
aaa:MonitoringPasswordType
          string:Password
monitoringPassword  (aaa:AProvider:monitoringPassword)
          
aaa:MonitoringUserType
          string:Basic
monitoringUser  (aaa:AProvider:monitoringUser)
          
aaa:ProviderState
          scalar:Enum8
operState  (aaa:AProvider:operState)
           The current state of the provider.
aaa:Retries
          scalar:Uint32
retries  (aaa:AProvider:retries)
           null
aaa:ProviderSnmpIndex
          scalar:Uint32
snmpIndex  (aaa:AProvider:snmpIndex)
           null
l3:VrfName
          string:Basic
vrfName  (aaa:AProvider:vrfName)
           The vrf that this client group belongs to
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           NO COMMENTS
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



entityId

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS



epgDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Management EpG dn



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





guiBannerMessage

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS



httpsProxy

Type: os:Hostname
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
NO COMMENTS



idP

Type: aaa:IdP
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
okta 0 OKTA NO COMMENTS
adfs 1 ADFS NO COMMENTS
ping identity 2 PING IDENTITY NO COMMENTS
DEFAULT adfs(1) ADFS NO COMMENTS





key

Type: aaa:Key
Primitive Type: string:Password

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "32"
        Allowed Chars:
            Regex: .*
    Comments:
A password for the AAA provider database.



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





metadataUrl

Type: aaa:MetadataUrl
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "2000"
    Comments:
NO COMMENTS



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



monitorServer

Type: aaa:MonitorServerType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
disabled 0 Disabled NO COMMENTS
enabled 1 Enabled NO COMMENTS
DEFAULT disabled(0) Disabled NO COMMENTS





monitoringPassword

Type: aaa:MonitoringPasswordType
Primitive Type: string:Password

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "32"
        Allowed Chars:
            Regex: .*
    Comments:



monitoringUser

Type: aaa:MonitoringUserType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Regex: [a-zA-Z0-9][a-zA-Z0-9_.@-]{0,31}
    Comments:
Constants
defaultValue "default" --- NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:aaa:AProvider:name  |  aaa:Definition:name  |  pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



operState

Type: aaa:ProviderState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The current state of the provider.
Constants
unknown 0 Unknown NO COMMENTS
operable 1 Operable NO COMMENTS
inoperable 2 Inoperable NO COMMENTS
DEFAULT unknown(0) Unknown NO COMMENTS





ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



retries

Type: aaa:Retries
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)5l
    Comments:
null
Constants
defaultValue 1u --- NO COMMENTS





rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



sigAlg

Type: aaa:SigAlg
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
SIG_RSA_SHA1 0 RSA SHA1 NO COMMENTS
SIG_RSA_SHA224 1 RSA SHA224 NO COMMENTS
SIG_RSA_SHA256 2 RSA SHA256 NO COMMENTS
SIG_RSA_SHA384 3 RSA SHA384 NO COMMENTS
SIG_RSA_SHA512 4 RSA SHA512 NO COMMENTS
DEFAULT SIG_RSA_SHA256(2) RSA SHA256 NO COMMENTS





snmpIndex

Type: aaa:ProviderSnmpIndex
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.






timeout

Type: aaa:TimeSec
Primitive Type: scalar:Uint32

Overrides:aaa:AProvider:timeout
Units: sec Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: (long)5l max: (long)60l
    Comments:
The amount of time between authentication attempts.
Constants
defaultValue 5u --- NO COMMENTS





tp

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS





vrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The vrf that this client group belongs to



wantAssertionsEncrypted

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





wantAssertionsSigned

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





wantRequestsSigned

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





wantResponseSigned

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS