1. Packages
  2. Intersight Provider
  3. API Docs
  4. getIamApiKey
intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet

intersight.getIamApiKey

Explore with Pulumi AI

intersight logo
intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet

    An API key is used to authenticate and authorize API requests sent by a client using the HTTP signature scheme. API keys can be used by unattended, daemon clients that need to send requests to Intersight programmatically. API keys are based on public key cryptography. To create an API key, the user must specify: 1. The purpose (description) of the API key, 2. The cryptographic hash algorithm, which is used to compute the digest of the body of HTTP requests, 3. The cryptographic parameters to generate a private/public key pair, e.g. RSA, ECDSA, EDDSA, key modulus, and 4. The signing algorithm, e.g. RSA PKCS v1.5, RSA PSS, ECDSA, EDDSA. The generated private key and public key are encoded in PEM format. The client owns the private key and is responsible for maintaining the confidentiality of the private key. The server holds the public key. The client must have a cryptographic provider compatible with the cryptographic parameters specified in the API key. For example, if you use the powershell SDK to write the client, make sure the appropriate cryptographic providers are installed on the local system. If you create an RSA key pair with modulus set to 2048, the client must support 2048-bit private keys. A maximum of 3 API keys per user is allowed. API keys are used to sign HTTP requests as follows: 1. A cryptographic digest of the body of the HTTP request is calculated using one of the supported cryptographic hash algorithms. 2. The value of the digest is base-64 encoded in the Digest HTTP header. 3. A signature is calculated as specified in the HTTP signature scheme, and the signature is added to the Authorization HTTP request header. All published Intersight SDKs support API keys.

    Using getIamApiKey

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIamApiKey(args: GetIamApiKeyArgs, opts?: InvokeOptions): Promise<GetIamApiKeyResult>
    function getIamApiKeyOutput(args: GetIamApiKeyOutputArgs, opts?: InvokeOptions): Output<GetIamApiKeyResult>
    def get_iam_api_key(account_moid: Optional[str] = None,
                        additional_properties: Optional[str] = None,
                        admin_status: Optional[str] = None,
                        ancestors: Optional[Sequence[GetIamApiKeyAncestor]] = None,
                        class_id: Optional[str] = None,
                        create_time: Optional[str] = None,
                        domain_group_moid: Optional[str] = None,
                        expiry_date_time: Optional[str] = None,
                        hash_algorithm: Optional[str] = None,
                        id: Optional[str] = None,
                        is_never_expiring: Optional[bool] = None,
                        key_spec: Optional[GetIamApiKeyKeySpec] = None,
                        last_used_ip: Optional[str] = None,
                        last_used_time: Optional[str] = None,
                        mod_time: Optional[str] = None,
                        moid: Optional[str] = None,
                        object_type: Optional[str] = None,
                        oper_status: Optional[str] = None,
                        owners: Optional[Sequence[str]] = None,
                        parent: Optional[GetIamApiKeyParent] = None,
                        permission: Optional[GetIamApiKeyPermission] = None,
                        permission_resources: Optional[Sequence[GetIamApiKeyPermissionResource]] = None,
                        private_key: Optional[str] = None,
                        purpose: Optional[str] = None,
                        scope: Optional[GetIamApiKeyScope] = None,
                        shared_scope: Optional[str] = None,
                        signing_algorithm: Optional[str] = None,
                        start_time: Optional[str] = None,
                        tags: Optional[Sequence[GetIamApiKeyTag]] = None,
                        user: Optional[GetIamApiKeyUser] = None,
                        version_context: Optional[GetIamApiKeyVersionContext] = None,
                        opts: Optional[InvokeOptions] = None) -> GetIamApiKeyResult
    def get_iam_api_key_output(account_moid: Optional[pulumi.Input[str]] = None,
                        additional_properties: Optional[pulumi.Input[str]] = None,
                        admin_status: Optional[pulumi.Input[str]] = None,
                        ancestors: Optional[pulumi.Input[Sequence[pulumi.Input[GetIamApiKeyAncestorArgs]]]] = None,
                        class_id: Optional[pulumi.Input[str]] = None,
                        create_time: Optional[pulumi.Input[str]] = None,
                        domain_group_moid: Optional[pulumi.Input[str]] = None,
                        expiry_date_time: Optional[pulumi.Input[str]] = None,
                        hash_algorithm: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        is_never_expiring: Optional[pulumi.Input[bool]] = None,
                        key_spec: Optional[pulumi.Input[GetIamApiKeyKeySpecArgs]] = None,
                        last_used_ip: Optional[pulumi.Input[str]] = None,
                        last_used_time: Optional[pulumi.Input[str]] = None,
                        mod_time: Optional[pulumi.Input[str]] = None,
                        moid: Optional[pulumi.Input[str]] = None,
                        object_type: Optional[pulumi.Input[str]] = None,
                        oper_status: Optional[pulumi.Input[str]] = None,
                        owners: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        parent: Optional[pulumi.Input[GetIamApiKeyParentArgs]] = None,
                        permission: Optional[pulumi.Input[GetIamApiKeyPermissionArgs]] = None,
                        permission_resources: Optional[pulumi.Input[Sequence[pulumi.Input[GetIamApiKeyPermissionResourceArgs]]]] = None,
                        private_key: Optional[pulumi.Input[str]] = None,
                        purpose: Optional[pulumi.Input[str]] = None,
                        scope: Optional[pulumi.Input[GetIamApiKeyScopeArgs]] = None,
                        shared_scope: Optional[pulumi.Input[str]] = None,
                        signing_algorithm: Optional[pulumi.Input[str]] = None,
                        start_time: Optional[pulumi.Input[str]] = None,
                        tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetIamApiKeyTagArgs]]]] = None,
                        user: Optional[pulumi.Input[GetIamApiKeyUserArgs]] = None,
                        version_context: Optional[pulumi.Input[GetIamApiKeyVersionContextArgs]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetIamApiKeyResult]
    func LookupIamApiKey(ctx *Context, args *LookupIamApiKeyArgs, opts ...InvokeOption) (*LookupIamApiKeyResult, error)
    func LookupIamApiKeyOutput(ctx *Context, args *LookupIamApiKeyOutputArgs, opts ...InvokeOption) LookupIamApiKeyResultOutput

    > Note: This function is named LookupIamApiKey in the Go SDK.

    public static class GetIamApiKey 
    {
        public static Task<GetIamApiKeyResult> InvokeAsync(GetIamApiKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetIamApiKeyResult> Invoke(GetIamApiKeyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIamApiKeyResult> getIamApiKey(GetIamApiKeyArgs args, InvokeOptions options)
    public static Output<GetIamApiKeyResult> getIamApiKey(GetIamApiKeyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: intersight:index/getIamApiKey:getIamApiKey
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountMoid string
    The Account ID for this managed object.
    AdditionalProperties string
    AdminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    Ancestors List<GetIamApiKeyAncestor>
    ClassId string
    CreateTime string
    The time when this managed object was created.
    DomainGroupMoid string
    The DomainGroup ID for this managed object.
    ExpiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    HashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    Id string
    IsNeverExpiring bool
    Used to mark the API key as a never-expiring API key.
    KeySpec GetIamApiKeyKeySpec
    LastUsedIp string
    The IP address from which the API key was last used.
    LastUsedTime string
    The time at which the API key was last used. It is updated every 24 hours.
    ModTime string
    The time when this managed object was last modified.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    OperStatus string
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    Owners List<string>
    Parent GetIamApiKeyParent
    Permission GetIamApiKeyPermission
    PermissionResources List<GetIamApiKeyPermissionResource>
    PrivateKey string
    Holds the private key for the API key.
    Purpose string
    The purpose of the API Key.
    Scope GetIamApiKeyScope
    SharedScope string
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    SigningAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    StartTime string
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    Tags List<GetIamApiKeyTag>
    User GetIamApiKeyUser
    VersionContext GetIamApiKeyVersionContext
    AccountMoid string
    The Account ID for this managed object.
    AdditionalProperties string
    AdminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    Ancestors []GetIamApiKeyAncestor
    ClassId string
    CreateTime string
    The time when this managed object was created.
    DomainGroupMoid string
    The DomainGroup ID for this managed object.
    ExpiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    HashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    Id string
    IsNeverExpiring bool
    Used to mark the API key as a never-expiring API key.
    KeySpec GetIamApiKeyKeySpec
    LastUsedIp string
    The IP address from which the API key was last used.
    LastUsedTime string
    The time at which the API key was last used. It is updated every 24 hours.
    ModTime string
    The time when this managed object was last modified.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    OperStatus string
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    Owners []string
    Parent GetIamApiKeyParent
    Permission GetIamApiKeyPermission
    PermissionResources []GetIamApiKeyPermissionResource
    PrivateKey string
    Holds the private key for the API key.
    Purpose string
    The purpose of the API Key.
    Scope GetIamApiKeyScope
    SharedScope string
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    SigningAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    StartTime string
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    Tags []GetIamApiKeyTag
    User GetIamApiKeyUser
    VersionContext GetIamApiKeyVersionContext
    accountMoid String
    The Account ID for this managed object.
    additionalProperties String
    adminStatus String
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors List<GetIamApiKeyAncestor>
    classId String
    createTime String
    The time when this managed object was created.
    domainGroupMoid String
    The DomainGroup ID for this managed object.
    expiryDateTime String
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm String
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    id String
    isNeverExpiring Boolean
    Used to mark the API key as a never-expiring API key.
    keySpec GetIamApiKeyKeySpec
    lastUsedIp String
    The IP address from which the API key was last used.
    lastUsedTime String
    The time at which the API key was last used. It is updated every 24 hours.
    modTime String
    The time when this managed object was last modified.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    operStatus String
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    owners List<String>
    parent GetIamApiKeyParent
    permission GetIamApiKeyPermission
    permissionResources List<GetIamApiKeyPermissionResource>
    privateKey String
    Holds the private key for the API key.
    purpose String
    The purpose of the API Key.
    scope GetIamApiKeyScope
    sharedScope String
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm String
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime String
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags List<GetIamApiKeyTag>
    user GetIamApiKeyUser
    versionContext GetIamApiKeyVersionContext
    accountMoid string
    The Account ID for this managed object.
    additionalProperties string
    adminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors GetIamApiKeyAncestor[]
    classId string
    createTime string
    The time when this managed object was created.
    domainGroupMoid string
    The DomainGroup ID for this managed object.
    expiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    id string
    isNeverExpiring boolean
    Used to mark the API key as a never-expiring API key.
    keySpec GetIamApiKeyKeySpec
    lastUsedIp string
    The IP address from which the API key was last used.
    lastUsedTime string
    The time at which the API key was last used. It is updated every 24 hours.
    modTime string
    The time when this managed object was last modified.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    operStatus string
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    owners string[]
    parent GetIamApiKeyParent
    permission GetIamApiKeyPermission
    permissionResources GetIamApiKeyPermissionResource[]
    privateKey string
    Holds the private key for the API key.
    purpose string
    The purpose of the API Key.
    scope GetIamApiKeyScope
    sharedScope string
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime string
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags GetIamApiKeyTag[]
    user GetIamApiKeyUser
    versionContext GetIamApiKeyVersionContext
    account_moid str
    The Account ID for this managed object.
    additional_properties str
    admin_status str
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors Sequence[GetIamApiKeyAncestor]
    class_id str
    create_time str
    The time when this managed object was created.
    domain_group_moid str
    The DomainGroup ID for this managed object.
    expiry_date_time str
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hash_algorithm str
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    id str
    is_never_expiring bool
    Used to mark the API key as a never-expiring API key.
    key_spec GetIamApiKeyKeySpec
    last_used_ip str
    The IP address from which the API key was last used.
    last_used_time str
    The time at which the API key was last used. It is updated every 24 hours.
    mod_time str
    The time when this managed object was last modified.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    oper_status str
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    owners Sequence[str]
    parent GetIamApiKeyParent
    permission GetIamApiKeyPermission
    permission_resources Sequence[GetIamApiKeyPermissionResource]
    private_key str
    Holds the private key for the API key.
    purpose str
    The purpose of the API Key.
    scope GetIamApiKeyScope
    shared_scope str
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signing_algorithm str
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    start_time str
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags Sequence[GetIamApiKeyTag]
    user GetIamApiKeyUser
    version_context GetIamApiKeyVersionContext
    accountMoid String
    The Account ID for this managed object.
    additionalProperties String
    adminStatus String
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors List<Property Map>
    classId String
    createTime String
    The time when this managed object was created.
    domainGroupMoid String
    The DomainGroup ID for this managed object.
    expiryDateTime String
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm String
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    id String
    isNeverExpiring Boolean
    Used to mark the API key as a never-expiring API key.
    keySpec Property Map
    lastUsedIp String
    The IP address from which the API key was last used.
    lastUsedTime String
    The time at which the API key was last used. It is updated every 24 hours.
    modTime String
    The time when this managed object was last modified.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    operStatus String
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    owners List<String>
    parent Property Map
    permission Property Map
    permissionResources List<Property Map>
    privateKey String
    Holds the private key for the API key.
    purpose String
    The purpose of the API Key.
    scope Property Map
    sharedScope String
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm String
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime String
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags List<Property Map>
    user Property Map
    versionContext Property Map

    getIamApiKey Result

    The following output properties are available:

    Supporting Types

    GetIamApiKeyAncestor

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the remote type referred by this relationship.
    selector str
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

    GetIamApiKeyKeySpec

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    Name string
    Name of the key generation algorithm.

    • RSA - Key pairs should be generated by the RSA algorithm.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    Name string
    Name of the key generation algorithm.

    • RSA - Key pairs should be generated by the RSA algorithm.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    name String
    Name of the key generation algorithm.

    • RSA - Key pairs should be generated by the RSA algorithm.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    name string
    Name of the key generation algorithm.

    • RSA - Key pairs should be generated by the RSA algorithm.
    objectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    name str
    Name of the key generation algorithm.

    • RSA - Key pairs should be generated by the RSA algorithm.
    object_type str
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. The enum values provides the list of concrete types that can be instantiated from this abstract type.
    name String
    Name of the key generation algorithm.

    • RSA - Key pairs should be generated by the RSA algorithm.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property. The enum values provides the list of concrete types that can be instantiated from this abstract type.

    GetIamApiKeyParent

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the remote type referred by this relationship.
    selector str
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

    GetIamApiKeyPermission

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the remote type referred by this relationship.
    selector str
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

    GetIamApiKeyPermissionResource

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the remote type referred by this relationship.
    selector str
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

    GetIamApiKeyResult

    AccountMoid string
    The Account ID for this managed object.
    AdditionalProperties string
    AdminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    Ancestors List<GetIamApiKeyResultAncestor>
    ClassId string
    CreateTime string
    The time when this managed object was created.
    DomainGroupMoid string
    The DomainGroup ID for this managed object.
    ExpiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    HashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    IsNeverExpiring bool
    Used to mark the API key as a never-expiring API key.
    KeySpecs List<GetIamApiKeyResultKeySpec>
    LastUsedIp string
    The IP address from which the API key was last used.
    LastUsedTime string
    The time at which the API key was last used. It is updated every 24 hours.
    ModTime string
    The time when this managed object was last modified.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    OperStatus string
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    Owners List<string>
    Parents List<GetIamApiKeyResultParent>
    PermissionResources List<GetIamApiKeyResultPermissionResource>
    Permissions List<GetIamApiKeyResultPermission>
    PrivateKey string
    Holds the private key for the API key.
    Purpose string
    The purpose of the API Key.
    Scopes List<GetIamApiKeyResultScope>
    SharedScope string
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    SigningAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    StartTime string
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    Tags List<GetIamApiKeyResultTag>
    Users List<GetIamApiKeyResultUser>
    VersionContexts List<GetIamApiKeyResultVersionContext>
    AccountMoid string
    The Account ID for this managed object.
    AdditionalProperties string
    AdminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    Ancestors []GetIamApiKeyResultAncestor
    ClassId string
    CreateTime string
    The time when this managed object was created.
    DomainGroupMoid string
    The DomainGroup ID for this managed object.
    ExpiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    HashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    IsNeverExpiring bool
    Used to mark the API key as a never-expiring API key.
    KeySpecs []GetIamApiKeyResultKeySpec
    LastUsedIp string
    The IP address from which the API key was last used.
    LastUsedTime string
    The time at which the API key was last used. It is updated every 24 hours.
    ModTime string
    The time when this managed object was last modified.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    OperStatus string
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    Owners []string
    Parents []GetIamApiKeyResultParent
    PermissionResources []GetIamApiKeyResultPermissionResource
    Permissions []GetIamApiKeyResultPermission
    PrivateKey string
    Holds the private key for the API key.
    Purpose string
    The purpose of the API Key.
    Scopes []GetIamApiKeyResultScope
    SharedScope string
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    SigningAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    StartTime string
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    Tags []GetIamApiKeyResultTag
    Users []GetIamApiKeyResultUser
    VersionContexts []GetIamApiKeyResultVersionContext
    accountMoid String
    The Account ID for this managed object.
    additionalProperties String
    adminStatus String
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors List<GetIamApiKeyResultAncestor>
    classId String
    createTime String
    The time when this managed object was created.
    domainGroupMoid String
    The DomainGroup ID for this managed object.
    expiryDateTime String
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm String
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    isNeverExpiring Boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs List<GetIamApiKeyResultKeySpec>
    lastUsedIp String
    The IP address from which the API key was last used.
    lastUsedTime String
    The time at which the API key was last used. It is updated every 24 hours.
    modTime String
    The time when this managed object was last modified.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    operStatus String
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    owners List<String>
    parents List<GetIamApiKeyResultParent>
    permissionResources List<GetIamApiKeyResultPermissionResource>
    permissions List<GetIamApiKeyResultPermission>
    privateKey String
    Holds the private key for the API key.
    purpose String
    The purpose of the API Key.
    scopes List<GetIamApiKeyResultScope>
    sharedScope String
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm String
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime String
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags List<GetIamApiKeyResultTag>
    users List<GetIamApiKeyResultUser>
    versionContexts List<GetIamApiKeyResultVersionContext>
    accountMoid string
    The Account ID for this managed object.
    additionalProperties string
    adminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors GetIamApiKeyResultAncestor[]
    classId string
    createTime string
    The time when this managed object was created.
    domainGroupMoid string
    The DomainGroup ID for this managed object.
    expiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    isNeverExpiring boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs GetIamApiKeyResultKeySpec[]
    lastUsedIp string
    The IP address from which the API key was last used.
    lastUsedTime string
    The time at which the API key was last used. It is updated every 24 hours.
    modTime string
    The time when this managed object was last modified.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    operStatus string
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    owners string[]
    parents GetIamApiKeyResultParent[]
    permissionResources GetIamApiKeyResultPermissionResource[]
    permissions GetIamApiKeyResultPermission[]
    privateKey string
    Holds the private key for the API key.
    purpose string
    The purpose of the API Key.
    scopes GetIamApiKeyResultScope[]
    sharedScope string
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime string
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags GetIamApiKeyResultTag[]
    users GetIamApiKeyResultUser[]
    versionContexts GetIamApiKeyResultVersionContext[]
    account_moid str
    The Account ID for this managed object.
    additional_properties str
    admin_status str
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors Sequence[GetIamApiKeyResultAncestor]
    class_id str
    create_time str
    The time when this managed object was created.
    domain_group_moid str
    The DomainGroup ID for this managed object.
    expiry_date_time str
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hash_algorithm str
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    is_never_expiring bool
    Used to mark the API key as a never-expiring API key.
    key_specs Sequence[GetIamApiKeyResultKeySpec]
    last_used_ip str
    The IP address from which the API key was last used.
    last_used_time str
    The time at which the API key was last used. It is updated every 24 hours.
    mod_time str
    The time when this managed object was last modified.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    oper_status str
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    owners Sequence[str]
    parents Sequence[GetIamApiKeyResultParent]
    permission_resources Sequence[GetIamApiKeyResultPermissionResource]
    permissions Sequence[GetIamApiKeyResultPermission]
    private_key str
    Holds the private key for the API key.
    purpose str
    The purpose of the API Key.
    scopes Sequence[GetIamApiKeyResultScope]
    shared_scope str
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signing_algorithm str
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    start_time str
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags Sequence[GetIamApiKeyResultTag]
    users Sequence[GetIamApiKeyResultUser]
    version_contexts Sequence[GetIamApiKeyResultVersionContext]
    accountMoid String
    The Account ID for this managed object.
    additionalProperties String
    adminStatus String
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors List<Property Map>
    classId String
    createTime String
    The time when this managed object was created.
    domainGroupMoid String
    The DomainGroup ID for this managed object.
    expiryDateTime String
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm String
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    isNeverExpiring Boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs List<Property Map>
    lastUsedIp String
    The IP address from which the API key was last used.
    lastUsedTime String
    The time at which the API key was last used. It is updated every 24 hours.
    modTime String
    The time when this managed object was last modified.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    operStatus String
    The current status of the API key that dictates the validity of the key.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.
    owners List<String>
    parents List<Property Map>
    permissionResources List<Property Map>
    permissions List<Property Map>
    privateKey String
    Holds the private key for the API key.
    purpose String
    The purpose of the API Key.
    scopes List<Property Map>
    sharedScope String
    Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm String
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime String
    The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags List<Property Map>
    users List<Property Map>
    versionContexts List<Property Map>

    GetIamApiKeyResultAncestor

    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String
    additionalProperties string
    classId string
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    selector string
    additional_properties str
    class_id str
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    selector str
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String

    GetIamApiKeyResultKeySpec

    AdditionalProperties string
    ClassId string
    Name string
    ObjectType string
    AdditionalProperties string
    ClassId string
    Name string
    ObjectType string
    additionalProperties String
    classId String
    name String
    objectType String
    additionalProperties string
    classId string
    name string
    objectType string
    additionalProperties String
    classId String
    name String
    objectType String

    GetIamApiKeyResultParent

    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String
    additionalProperties string
    classId string
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    selector string
    additional_properties str
    class_id str
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    selector str
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String

    GetIamApiKeyResultPermission

    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String
    additionalProperties string
    classId string
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    selector string
    additional_properties str
    class_id str
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    selector str
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String

    GetIamApiKeyResultPermissionResource

    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String
    additionalProperties string
    classId string
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    selector string
    additional_properties str
    class_id str
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    selector str
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String

    GetIamApiKeyResultScope

    GetIamApiKeyResultScopeSwitchedFromAccount

    GetIamApiKeyResultScopeSwitchedToAccount

    GetIamApiKeyResultTag

    AdditionalProperties string
    Key string
    Value string
    AdditionalProperties string
    Key string
    Value string
    additionalProperties String
    key String
    value String
    additionalProperties string
    key string
    value string
    additionalProperties String
    key String
    value String

    GetIamApiKeyResultUser

    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String
    additionalProperties string
    classId string
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    selector string
    additional_properties str
    class_id str
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    selector str
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String

    GetIamApiKeyResultVersionContext

    GetIamApiKeyResultVersionContextInterestedMo

    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String
    additionalProperties string
    classId string
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    selector string
    additional_properties str
    class_id str
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    selector str
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String

    GetIamApiKeyResultVersionContextRefMo

    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    AdditionalProperties string
    ClassId string
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    Selector string
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String
    additionalProperties string
    classId string
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    selector string
    additional_properties str
    class_id str
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    selector str
    additionalProperties String
    classId String
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    selector String

    GetIamApiKeyScope

    AccountAccessControlId string
    Moid of the AccountAccessControl through which the access is given to switch scope.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    RequestIdentifier string
    Stores the identifier of the issue for which user is trying to switch scope to another account.
    SwitchedFromAccount GetIamApiKeyScopeSwitchedFromAccount
    Permission for the Account from which user switched the scope.
    SwitchedToAccounts List<GetIamApiKeyScopeSwitchedToAccount>
    AccountAccessControlId string
    Moid of the AccountAccessControl through which the access is given to switch scope.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    RequestIdentifier string
    Stores the identifier of the issue for which user is trying to switch scope to another account.
    SwitchedFromAccount GetIamApiKeyScopeSwitchedFromAccount
    Permission for the Account from which user switched the scope.
    SwitchedToAccounts []GetIamApiKeyScopeSwitchedToAccount
    accountAccessControlId String
    Moid of the AccountAccessControl through which the access is given to switch scope.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    requestIdentifier String
    Stores the identifier of the issue for which user is trying to switch scope to another account.
    switchedFromAccount GetIamApiKeyScopeSwitchedFromAccount
    Permission for the Account from which user switched the scope.
    switchedToAccounts List<GetIamApiKeyScopeSwitchedToAccount>
    accountAccessControlId string
    Moid of the AccountAccessControl through which the access is given to switch scope.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    requestIdentifier string
    Stores the identifier of the issue for which user is trying to switch scope to another account.
    switchedFromAccount GetIamApiKeyScopeSwitchedFromAccount
    Permission for the Account from which user switched the scope.
    switchedToAccounts GetIamApiKeyScopeSwitchedToAccount[]
    account_access_control_id str
    Moid of the AccountAccessControl through which the access is given to switch scope.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    object_type str
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    request_identifier str
    Stores the identifier of the issue for which user is trying to switch scope to another account.
    switched_from_account GetIamApiKeyScopeSwitchedFromAccount
    Permission for the Account from which user switched the scope.
    switched_to_accounts Sequence[GetIamApiKeyScopeSwitchedToAccount]
    accountAccessControlId String
    Moid of the AccountAccessControl through which the access is given to switch scope.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    requestIdentifier String
    Stores the identifier of the issue for which user is trying to switch scope to another account.
    switchedFromAccount Property Map
    Permission for the Account from which user switched the scope.
    switchedToAccounts List<Property Map>

    GetIamApiKeyScopeSwitchedFromAccount

    AccountId string
    Moid of the Account to/from which user switched the scope.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    PermissionId string
    Moid of the Permission for the Account to/from which user switched the scope.
    AccountId string
    Moid of the Account to/from which user switched the scope.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    PermissionId string
    Moid of the Permission for the Account to/from which user switched the scope.
    accountId String
    Moid of the Account to/from which user switched the scope.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    permissionId String
    Moid of the Permission for the Account to/from which user switched the scope.
    accountId string
    Moid of the Account to/from which user switched the scope.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    permissionId string
    Moid of the Permission for the Account to/from which user switched the scope.
    account_id str
    Moid of the Account to/from which user switched the scope.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    object_type str
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    permission_id str
    Moid of the Permission for the Account to/from which user switched the scope.
    accountId String
    Moid of the Account to/from which user switched the scope.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    permissionId String
    Moid of the Permission for the Account to/from which user switched the scope.

    GetIamApiKeyScopeSwitchedToAccount

    AccountId string
    Moid of the Account to/from which user switched the scope.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    PermissionId string
    Moid of the Permission for the Account to/from which user switched the scope.
    AccountId string
    Moid of the Account to/from which user switched the scope.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    PermissionId string
    Moid of the Permission for the Account to/from which user switched the scope.
    accountId String
    Moid of the Account to/from which user switched the scope.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    permissionId String
    Moid of the Permission for the Account to/from which user switched the scope.
    accountId string
    Moid of the Account to/from which user switched the scope.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    permissionId string
    Moid of the Permission for the Account to/from which user switched the scope.
    account_id str
    Moid of the Account to/from which user switched the scope.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    object_type str
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    permission_id str
    Moid of the Permission for the Account to/from which user switched the scope.
    accountId String
    Moid of the Account to/from which user switched the scope.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    permissionId String
    Moid of the Permission for the Account to/from which user switched the scope.

    GetIamApiKeyTag

    AdditionalProperties string
    Key string
    The string representation of a tag key.
    Value string
    The string representation of a tag value.
    AdditionalProperties string
    Key string
    The string representation of a tag key.
    Value string
    The string representation of a tag value.
    additionalProperties String
    key String
    The string representation of a tag key.
    value String
    The string representation of a tag value.
    additionalProperties string
    key string
    The string representation of a tag key.
    value string
    The string representation of a tag value.
    additional_properties str
    key str
    The string representation of a tag key.
    value str
    The string representation of a tag value.
    additionalProperties String
    key String
    The string representation of a tag key.
    value String
    The string representation of a tag value.

    GetIamApiKeyUser

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the remote type referred by this relationship.
    selector str
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

    GetIamApiKeyVersionContext

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    InterestedMos List<GetIamApiKeyVersionContextInterestedMo>
    MarkedForDeletion bool
    The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    NrVersion string
    The version of the Managed Object, e.g. an incrementing number or a hash id.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    RefMo GetIamApiKeyVersionContextRefMo
    A reference to the original Managed Object.
    Timestamp string
    The time this versioned Managed Object was created.
    VersionType string
    Specifies type of version. Currently the only supported value is "Configured" that is used to keep track of snapshots of policies and profiles that are intended to be configured to target endpoints.

    • Modified - Version created every time an object is modified.
    • Configured - Version created every time an object is configured to the service profile.
    • Deployed - Version created for objects related to a service profile when it is deployed.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    InterestedMos []GetIamApiKeyVersionContextInterestedMo
    MarkedForDeletion bool
    The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    NrVersion string
    The version of the Managed Object, e.g. an incrementing number or a hash id.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    RefMo GetIamApiKeyVersionContextRefMo
    A reference to the original Managed Object.
    Timestamp string
    The time this versioned Managed Object was created.
    VersionType string
    Specifies type of version. Currently the only supported value is "Configured" that is used to keep track of snapshots of policies and profiles that are intended to be configured to target endpoints.

    • Modified - Version created every time an object is modified.
    • Configured - Version created every time an object is configured to the service profile.
    • Deployed - Version created for objects related to a service profile when it is deployed.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    interestedMos List<GetIamApiKeyVersionContextInterestedMo>
    markedForDeletion Boolean
    The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    nrVersion String
    The version of the Managed Object, e.g. an incrementing number or a hash id.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    refMo GetIamApiKeyVersionContextRefMo
    A reference to the original Managed Object.
    timestamp String
    The time this versioned Managed Object was created.
    versionType String
    Specifies type of version. Currently the only supported value is "Configured" that is used to keep track of snapshots of policies and profiles that are intended to be configured to target endpoints.

    • Modified - Version created every time an object is modified.
    • Configured - Version created every time an object is configured to the service profile.
    • Deployed - Version created for objects related to a service profile when it is deployed.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    interestedMos GetIamApiKeyVersionContextInterestedMo[]
    markedForDeletion boolean
    The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    nrVersion string
    The version of the Managed Object, e.g. an incrementing number or a hash id.
    objectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    refMo GetIamApiKeyVersionContextRefMo
    A reference to the original Managed Object.
    timestamp string
    The time this versioned Managed Object was created.
    versionType string
    Specifies type of version. Currently the only supported value is "Configured" that is used to keep track of snapshots of policies and profiles that are intended to be configured to target endpoints.

    • Modified - Version created every time an object is modified.
    • Configured - Version created every time an object is configured to the service profile.
    • Deployed - Version created for objects related to a service profile when it is deployed.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    interested_mos Sequence[GetIamApiKeyVersionContextInterestedMo]
    marked_for_deletion bool
    The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    nr_version str
    The version of the Managed Object, e.g. an incrementing number or a hash id.
    object_type str
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    ref_mo GetIamApiKeyVersionContextRefMo
    A reference to the original Managed Object.
    timestamp str
    The time this versioned Managed Object was created.
    version_type str
    Specifies type of version. Currently the only supported value is "Configured" that is used to keep track of snapshots of policies and profiles that are intended to be configured to target endpoints.

    • Modified - Version created every time an object is modified.
    • Configured - Version created every time an object is configured to the service profile.
    • Deployed - Version created for objects related to a service profile when it is deployed.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    interestedMos List<Property Map>
    markedForDeletion Boolean
    The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    nrVersion String
    The version of the Managed Object, e.g. an incrementing number or a hash id.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    refMo Property Map
    A reference to the original Managed Object.
    timestamp String
    The time this versioned Managed Object was created.
    versionType String
    Specifies type of version. Currently the only supported value is "Configured" that is used to keep track of snapshots of policies and profiles that are intended to be configured to target endpoints.

    • Modified - Version created every time an object is modified.
    • Configured - Version created every time an object is configured to the service profile.
    • Deployed - Version created for objects related to a service profile when it is deployed.

    GetIamApiKeyVersionContextInterestedMo

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the remote type referred by this relationship.
    selector str
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

    GetIamApiKeyVersionContextRefMo

    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additional_properties str
    class_id str
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the remote type referred by this relationship.
    selector str
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

    1. If 'moid' is set this field is ignored.
    2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

    Package Details

    Repository
    intersight ciscodevnet/terraform-provider-intersight
    License
    Notes
    This Pulumi package is based on the intersight Terraform Provider.
    intersight logo
    intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet