intersight.getIamApiKey
Explore with Pulumi AI
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:
- Account
Moid string - The Account ID for this managed object.
- Additional
Properties string - Admin
Status 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<Get
Iam Api Key Ancestor> - Class
Id string - Create
Time string - The time when this managed object was created.
- Domain
Group stringMoid - The DomainGroup ID for this managed object.
- Expiry
Date stringTime - 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 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
- Is
Never boolExpiring - Used to mark the API key as a never-expiring API key.
- Key
Spec GetIam Api Key Key Spec - Last
Used stringIp - The IP address from which the API key was last used.
- Last
Used stringTime - The time at which the API key was last used. It is updated every 24 hours.
- Mod
Time string - The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Oper
Status 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
Get
Iam Api Key Parent - Permission
Get
Iam Api Key Permission - Permission
Resources List<GetIam Api Key Permission Resource> - Private
Key string - Holds the private key for the API key.
- Purpose string
- The purpose of the API Key.
- Scope
Get
Iam Api Key Scope - 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.
- Signing
Algorithm 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. - Start
Time 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.
- List<Get
Iam Api Key Tag> - User
Get
Iam Api Key User - Version
Context GetIam Api Key Version Context
- Account
Moid string - The Account ID for this managed object.
- Additional
Properties string - Admin
Status 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
[]Get
Iam Api Key Ancestor - Class
Id string - Create
Time string - The time when this managed object was created.
- Domain
Group stringMoid - The DomainGroup ID for this managed object.
- Expiry
Date stringTime - 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 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
- Is
Never boolExpiring - Used to mark the API key as a never-expiring API key.
- Key
Spec GetIam Api Key Key Spec - Last
Used stringIp - The IP address from which the API key was last used.
- Last
Used stringTime - The time at which the API key was last used. It is updated every 24 hours.
- Mod
Time string - The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Oper
Status 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
Get
Iam Api Key Parent - Permission
Get
Iam Api Key Permission - Permission
Resources []GetIam Api Key Permission Resource - Private
Key string - Holds the private key for the API key.
- Purpose string
- The purpose of the API Key.
- Scope
Get
Iam Api Key Scope - 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.
- Signing
Algorithm 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. - Start
Time 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.
- []Get
Iam Api Key Tag - User
Get
Iam Api Key User - Version
Context GetIam Api Key Version Context
- account
Moid String - The Account ID for this managed object.
- additional
Properties String - admin
Status 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<Get
Iam Api Key Ancestor> - class
Id String - create
Time String - The time when this managed object was created.
- domain
Group StringMoid - The DomainGroup ID for this managed object.
- expiry
Date StringTime - 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 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
- is
Never BooleanExpiring - Used to mark the API key as a never-expiring API key.
- key
Spec GetIam Api Key Key Spec - last
Used StringIp - The IP address from which the API key was last used.
- last
Used StringTime - The time at which the API key was last used. It is updated every 24 hours.
- mod
Time String - The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - oper
Status 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
Get
Iam Api Key Parent - permission
Get
Iam Api Key Permission - permission
Resources List<GetIam Api Key Permission Resource> - private
Key String - Holds the private key for the API key.
- purpose String
- The purpose of the API Key.
- scope
Get
Iam Api Key Scope - 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.
- signing
Algorithm 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. - start
Time 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.
- List<Get
Iam Api Key Tag> - user
Get
Iam Api Key User - version
Context GetIam Api Key Version Context
- account
Moid string - The Account ID for this managed object.
- additional
Properties string - admin
Status 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
Get
Iam Api Key Ancestor[] - class
Id string - create
Time string - The time when this managed object was created.
- domain
Group stringMoid - The DomainGroup ID for this managed object.
- expiry
Date stringTime - 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 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
- is
Never booleanExpiring - Used to mark the API key as a never-expiring API key.
- key
Spec GetIam Api Key Key Spec - last
Used stringIp - The IP address from which the API key was last used.
- last
Used stringTime - The time at which the API key was last used. It is updated every 24 hours.
- mod
Time string - The time when this managed object was last modified.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - oper
Status 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
Get
Iam Api Key Parent - permission
Get
Iam Api Key Permission - permission
Resources GetIam Api Key Permission Resource[] - private
Key string - Holds the private key for the API key.
- purpose string
- The purpose of the API Key.
- scope
Get
Iam Api Key Scope - 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.
- signing
Algorithm 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. - start
Time 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.
- Get
Iam Api Key Tag[] - user
Get
Iam Api Key User - version
Context GetIam Api Key Version Context
- 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[Get
Iam Api Key Ancestor] - class_
id str - create_
time str - The time when this managed object was created.
- domain_
group_ strmoid - The DomainGroup ID for this managed object.
- expiry_
date_ strtime - 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_ boolexpiring - Used to mark the API key as a never-expiring API key.
- key_
spec GetIam Api Key Key Spec - last_
used_ strip - The IP address from which the API key was last used.
- last_
used_ strtime - 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
Get
Iam Api Key Parent - permission
Get
Iam Api Key Permission - permission_
resources Sequence[GetIam Api Key Permission Resource] - private_
key str - Holds the private key for the API key.
- purpose str
- The purpose of the API Key.
- scope
Get
Iam Api Key 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.
- Sequence[Get
Iam Api Key Tag] - user
Get
Iam Api Key User - version_
context GetIam Api Key Version Context
- account
Moid String - The Account ID for this managed object.
- additional
Properties String - admin
Status 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>
- class
Id String - create
Time String - The time when this managed object was created.
- domain
Group StringMoid - The DomainGroup ID for this managed object.
- expiry
Date StringTime - 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 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
- is
Never BooleanExpiring - Used to mark the API key as a never-expiring API key.
- key
Spec Property Map - last
Used StringIp - The IP address from which the API key was last used.
- last
Used StringTime - The time at which the API key was last used. It is updated every 24 hours.
- mod
Time String - The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - oper
Status 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
- permission
Resources List<Property Map> - private
Key String - Holds the private key for the API key.
- purpose String
- The purpose of the API Key.
- scope Property Map
- 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.
- signing
Algorithm 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. - start
Time 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.
- List<Property Map>
- user Property Map
- version
Context Property Map
getIamApiKey Result
The following output properties are available:
- Id string
- Results
List<Get
Iam Api Key Result> - Account
Moid string - Additional
Properties string - Admin
Status string - Ancestors
List<Get
Iam Api Key Ancestor> - Class
Id string - Create
Time string - Domain
Group stringMoid - Expiry
Date stringTime - Hash
Algorithm string - Is
Never boolExpiring - Key
Spec GetIam Api Key Key Spec - Last
Used stringIp - Last
Used stringTime - Mod
Time string - Moid string
- Object
Type string - Oper
Status string - Owners List<string>
- Parent
Get
Iam Api Key Parent - Permission
Get
Iam Api Key Permission - Permission
Resources List<GetIam Api Key Permission Resource> - Private
Key string - Purpose string
- Scope
Get
Iam Api Key Scope - string
- Signing
Algorithm string - Start
Time string - List<Get
Iam Api Key Tag> - User
Get
Iam Api Key User - Version
Context GetIam Api Key Version Context
- Id string
- Results
[]Get
Iam Api Key Result - Account
Moid string - Additional
Properties string - Admin
Status string - Ancestors
[]Get
Iam Api Key Ancestor - Class
Id string - Create
Time string - Domain
Group stringMoid - Expiry
Date stringTime - Hash
Algorithm string - Is
Never boolExpiring - Key
Spec GetIam Api Key Key Spec - Last
Used stringIp - Last
Used stringTime - Mod
Time string - Moid string
- Object
Type string - Oper
Status string - Owners []string
- Parent
Get
Iam Api Key Parent - Permission
Get
Iam Api Key Permission - Permission
Resources []GetIam Api Key Permission Resource - Private
Key string - Purpose string
- Scope
Get
Iam Api Key Scope - string
- Signing
Algorithm string - Start
Time string - []Get
Iam Api Key Tag - User
Get
Iam Api Key User - Version
Context GetIam Api Key Version Context
- id String
- results
List<Get
Iam Api Key Result> - account
Moid String - additional
Properties String - admin
Status String - ancestors
List<Get
Iam Api Key Ancestor> - class
Id String - create
Time String - domain
Group StringMoid - expiry
Date StringTime - hash
Algorithm String - is
Never BooleanExpiring - key
Spec GetIam Api Key Key Spec - last
Used StringIp - last
Used StringTime - mod
Time String - moid String
- object
Type String - oper
Status String - owners List<String>
- parent
Get
Iam Api Key Parent - permission
Get
Iam Api Key Permission - permission
Resources List<GetIam Api Key Permission Resource> - private
Key String - purpose String
- scope
Get
Iam Api Key Scope - String
- signing
Algorithm String - start
Time String - List<Get
Iam Api Key Tag> - user
Get
Iam Api Key User - version
Context GetIam Api Key Version Context
- id string
- results
Get
Iam Api Key Result[] - account
Moid string - additional
Properties string - admin
Status string - ancestors
Get
Iam Api Key Ancestor[] - class
Id string - create
Time string - domain
Group stringMoid - expiry
Date stringTime - hash
Algorithm string - is
Never booleanExpiring - key
Spec GetIam Api Key Key Spec - last
Used stringIp - last
Used stringTime - mod
Time string - moid string
- object
Type string - oper
Status string - owners string[]
- parent
Get
Iam Api Key Parent - permission
Get
Iam Api Key Permission - permission
Resources GetIam Api Key Permission Resource[] - private
Key string - purpose string
- scope
Get
Iam Api Key Scope - string
- signing
Algorithm string - start
Time string - Get
Iam Api Key Tag[] - user
Get
Iam Api Key User - version
Context GetIam Api Key Version Context
- id str
- results
Sequence[Get
Iam Api Key Result] - account_
moid str - additional_
properties str - admin_
status str - ancestors
Sequence[Get
Iam Api Key Ancestor] - class_
id str - create_
time str - domain_
group_ strmoid - expiry_
date_ strtime - hash_
algorithm str - is_
never_ boolexpiring - key_
spec GetIam Api Key Key Spec - last_
used_ strip - last_
used_ strtime - mod_
time str - moid str
- object_
type str - oper_
status str - owners Sequence[str]
- parent
Get
Iam Api Key Parent - permission
Get
Iam Api Key Permission - permission_
resources Sequence[GetIam Api Key Permission Resource] - private_
key str - purpose str
- scope
Get
Iam Api Key Scope - str
- signing_
algorithm str - start_
time str - Sequence[Get
Iam Api Key Tag] - user
Get
Iam Api Key User - version_
context GetIam Api Key Version Context
- id String
- results List<Property Map>
- account
Moid String - additional
Properties String - admin
Status String - ancestors List<Property Map>
- class
Id String - create
Time String - domain
Group StringMoid - expiry
Date StringTime - hash
Algorithm String - is
Never BooleanExpiring - key
Spec Property Map - last
Used StringIp - last
Used StringTime - mod
Time String - moid String
- object
Type String - oper
Status String - owners List<String>
- parent Property Map
- permission Property Map
- permission
Resources List<Property Map> - private
Key String - purpose String
- scope Property Map
- String
- signing
Algorithm String - start
Time String - List<Property Map>
- user Property Map
- version
Context Property Map
Supporting Types
GetIamApiKeyAncestor
- Additional
Properties string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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
- Additional
Properties string - Class
Id 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.
- Object
Type 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 string - Class
Id 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.
- Object
Type 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 String - class
Id 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.
- object
Type 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 string - class
Id 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.
- object
Type 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.
- additional
Properties String - class
Id 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.
- object
Type 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
- Additional
Properties string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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
- Additional
Properties string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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
- Additional
Properties string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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
- Account
Moid string - The Account ID for this managed object.
- Additional
Properties string - Admin
Status 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<Get
Iam Api Key Result Ancestor> - Class
Id string - Create
Time string - The time when this managed object was created.
- Domain
Group stringMoid - The DomainGroup ID for this managed object.
- Expiry
Date stringTime - 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 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. - Is
Never boolExpiring - Used to mark the API key as a never-expiring API key.
- Key
Specs List<GetIam Api Key Result Key Spec> - Last
Used stringIp - The IP address from which the API key was last used.
- Last
Used stringTime - The time at which the API key was last used. It is updated every 24 hours.
- Mod
Time string - The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Oper
Status 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<Get
Iam Api Key Result Parent> - Permission
Resources List<GetIam Api Key Result Permission Resource> - Permissions
List<Get
Iam Api Key Result Permission> - Private
Key string - Holds the private key for the API key.
- Purpose string
- The purpose of the API Key.
- Scopes
List<Get
Iam Api Key Result Scope> - 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.
- Signing
Algorithm 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. - Start
Time 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.
- List<Get
Iam Api Key Result Tag> - Users
List<Get
Iam Api Key Result User> - Version
Contexts List<GetIam Api Key Result Version Context>
- Account
Moid string - The Account ID for this managed object.
- Additional
Properties string - Admin
Status 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
[]Get
Iam Api Key Result Ancestor - Class
Id string - Create
Time string - The time when this managed object was created.
- Domain
Group stringMoid - The DomainGroup ID for this managed object.
- Expiry
Date stringTime - 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 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. - Is
Never boolExpiring - Used to mark the API key as a never-expiring API key.
- Key
Specs []GetIam Api Key Result Key Spec - Last
Used stringIp - The IP address from which the API key was last used.
- Last
Used stringTime - The time at which the API key was last used. It is updated every 24 hours.
- Mod
Time string - The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Oper
Status 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
[]Get
Iam Api Key Result Parent - Permission
Resources []GetIam Api Key Result Permission Resource - Permissions
[]Get
Iam Api Key Result Permission - Private
Key string - Holds the private key for the API key.
- Purpose string
- The purpose of the API Key.
- Scopes
[]Get
Iam Api Key Result Scope - 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.
- Signing
Algorithm 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. - Start
Time 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.
- []Get
Iam Api Key Result Tag - Users
[]Get
Iam Api Key Result User - Version
Contexts []GetIam Api Key Result Version Context
- account
Moid String - The Account ID for this managed object.
- additional
Properties String - admin
Status 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<Get
Iam Api Key Result Ancestor> - class
Id String - create
Time String - The time when this managed object was created.
- domain
Group StringMoid - The DomainGroup ID for this managed object.
- expiry
Date StringTime - 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 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. - is
Never BooleanExpiring - Used to mark the API key as a never-expiring API key.
- key
Specs List<GetIam Api Key Result Key Spec> - last
Used StringIp - The IP address from which the API key was last used.
- last
Used StringTime - The time at which the API key was last used. It is updated every 24 hours.
- mod
Time String - The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - oper
Status 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<Get
Iam Api Key Result Parent> - permission
Resources List<GetIam Api Key Result Permission Resource> - permissions
List<Get
Iam Api Key Result Permission> - private
Key String - Holds the private key for the API key.
- purpose String
- The purpose of the API Key.
- scopes
List<Get
Iam Api Key Result Scope> - 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.
- signing
Algorithm 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. - start
Time 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.
- List<Get
Iam Api Key Result Tag> - users
List<Get
Iam Api Key Result User> - version
Contexts List<GetIam Api Key Result Version Context>
- account
Moid string - The Account ID for this managed object.
- additional
Properties string - admin
Status 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
Get
Iam Api Key Result Ancestor[] - class
Id string - create
Time string - The time when this managed object was created.
- domain
Group stringMoid - The DomainGroup ID for this managed object.
- expiry
Date stringTime - 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 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. - is
Never booleanExpiring - Used to mark the API key as a never-expiring API key.
- key
Specs GetIam Api Key Result Key Spec[] - last
Used stringIp - The IP address from which the API key was last used.
- last
Used stringTime - The time at which the API key was last used. It is updated every 24 hours.
- mod
Time string - The time when this managed object was last modified.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - oper
Status 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
Get
Iam Api Key Result Parent[] - permission
Resources GetIam Api Key Result Permission Resource[] - permissions
Get
Iam Api Key Result Permission[] - private
Key string - Holds the private key for the API key.
- purpose string
- The purpose of the API Key.
- scopes
Get
Iam Api Key Result Scope[] - 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.
- signing
Algorithm 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. - start
Time 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.
- Get
Iam Api Key Result Tag[] - users
Get
Iam Api Key Result User[] - version
Contexts GetIam Api Key Result Version Context[]
- 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[Get
Iam Api Key Result Ancestor] - class_
id str - create_
time str - The time when this managed object was created.
- domain_
group_ strmoid - The DomainGroup ID for this managed object.
- expiry_
date_ strtime - 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_ boolexpiring - Used to mark the API key as a never-expiring API key.
- key_
specs Sequence[GetIam Api Key Result Key Spec] - last_
used_ strip - The IP address from which the API key was last used.
- last_
used_ strtime - 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[Get
Iam Api Key Result Parent] - permission_
resources Sequence[GetIam Api Key Result Permission Resource] - permissions
Sequence[Get
Iam Api Key Result Permission] - private_
key str - Holds the private key for the API key.
- purpose str
- The purpose of the API Key.
- scopes
Sequence[Get
Iam Api Key Result 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.
- Sequence[Get
Iam Api Key Result Tag] - users
Sequence[Get
Iam Api Key Result User] - version_
contexts Sequence[GetIam Api Key Result Version Context]
- account
Moid String - The Account ID for this managed object.
- additional
Properties String - admin
Status 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>
- class
Id String - create
Time String - The time when this managed object was created.
- domain
Group StringMoid - The DomainGroup ID for this managed object.
- expiry
Date StringTime - 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 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. - is
Never BooleanExpiring - Used to mark the API key as a never-expiring API key.
- key
Specs List<Property Map> - last
Used StringIp - The IP address from which the API key was last used.
- last
Used StringTime - The time at which the API key was last used. It is updated every 24 hours.
- mod
Time String - The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - oper
Status 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>
- permission
Resources List<Property Map> - permissions List<Property Map>
- private
Key String - Holds the private key for the API key.
- purpose String
- The purpose of the API Key.
- scopes List<Property Map>
- 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.
- signing
Algorithm 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. - start
Time 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.
- List<Property Map>
- users List<Property Map>
- version
Contexts List<Property Map>
GetIamApiKeyResultAncestor
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetIamApiKeyResultKeySpec
- Additional
Properties string - Class
Id string - Name string
- Object
Type string
- Additional
Properties string - Class
Id string - Name string
- Object
Type string
- additional
Properties String - class
Id String - name String
- object
Type String
- additional
Properties string - class
Id string - name string
- object
Type string
- additional_
properties str - class_
id str - name str
- object_
type str
- additional
Properties String - class
Id String - name String
- object
Type String
GetIamApiKeyResultParent
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetIamApiKeyResultPermission
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetIamApiKeyResultPermissionResource
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetIamApiKeyResultScope
GetIamApiKeyResultScopeSwitchedFromAccount
- Account
Id string - Additional
Properties string - Class
Id string - Object
Type string - Permission
Id string
- Account
Id string - Additional
Properties string - Class
Id string - Object
Type string - Permission
Id string
- account
Id String - additional
Properties String - class
Id String - object
Type String - permission
Id String
- account
Id string - additional
Properties string - class
Id string - object
Type string - permission
Id string
- account_
id str - additional_
properties str - class_
id str - object_
type str - permission_
id str
- account
Id String - additional
Properties String - class
Id String - object
Type String - permission
Id String
GetIamApiKeyResultScopeSwitchedToAccount
- Account
Id string - Additional
Properties string - Class
Id string - Object
Type string - Permission
Id string
- Account
Id string - Additional
Properties string - Class
Id string - Object
Type string - Permission
Id string
- account
Id String - additional
Properties String - class
Id String - object
Type String - permission
Id String
- account
Id string - additional
Properties string - class
Id string - object
Type string - permission
Id string
- account_
id str - additional_
properties str - class_
id str - object_
type str - permission_
id str
- account
Id String - additional
Properties String - class
Id String - object
Type String - permission
Id String
GetIamApiKeyResultTag
- Additional
Properties string - Key string
- Value string
- Additional
Properties string - Key string
- Value string
- additional
Properties String - key String
- value String
- additional
Properties string - key string
- value string
- additional_
properties str - key str
- value str
- additional
Properties String - key String
- value String
GetIamApiKeyResultUser
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetIamApiKeyResultVersionContext
- Additional
Properties string - Class
Id string - Interested
Mos List<GetIam Api Key Result Version Context Interested Mo> - Marked
For boolDeletion - Nr
Version string - Object
Type string - Ref
Mos List<GetIam Api Key Result Version Context Ref Mo> - Timestamp string
- Version
Type string
- Additional
Properties string - Class
Id string - Interested
Mos []GetIam Api Key Result Version Context Interested Mo - Marked
For boolDeletion - Nr
Version string - Object
Type string - Ref
Mos []GetIam Api Key Result Version Context Ref Mo - Timestamp string
- Version
Type string
- additional
Properties String - class
Id String - interested
Mos List<GetIam Api Key Result Version Context Interested Mo> - marked
For BooleanDeletion - nr
Version String - object
Type String - ref
Mos List<GetIam Api Key Result Version Context Ref Mo> - timestamp String
- version
Type String
- additional
Properties string - class
Id string - interested
Mos GetIam Api Key Result Version Context Interested Mo[] - marked
For booleanDeletion - nr
Version string - object
Type string - ref
Mos GetIam Api Key Result Version Context Ref Mo[] - timestamp string
- version
Type string
- additional
Properties String - class
Id String - interested
Mos List<Property Map> - marked
For BooleanDeletion - nr
Version String - object
Type String - ref
Mos List<Property Map> - timestamp String
- version
Type String
GetIamApiKeyResultVersionContextInterestedMo
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetIamApiKeyResultVersionContextRefMo
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetIamApiKeyScope
- Account
Access stringControl Id - Moid of the AccountAccessControl through which the access is given to switch scope.
- Additional
Properties string - Class
Id 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.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Request
Identifier string - Stores the identifier of the issue for which user is trying to switch scope to another account.
- Switched
From GetAccount Iam Api Key Scope Switched From Account - Permission for the Account from which user switched the scope.
- Switched
To List<GetAccounts Iam Api Key Scope Switched To Account>
- Account
Access stringControl Id - Moid of the AccountAccessControl through which the access is given to switch scope.
- Additional
Properties string - Class
Id 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.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Request
Identifier string - Stores the identifier of the issue for which user is trying to switch scope to another account.
- Switched
From GetAccount Iam Api Key Scope Switched From Account - Permission for the Account from which user switched the scope.
- Switched
To []GetAccounts Iam Api Key Scope Switched To Account
- account
Access StringControl Id - Moid of the AccountAccessControl through which the access is given to switch scope.
- additional
Properties String - class
Id 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- request
Identifier String - Stores the identifier of the issue for which user is trying to switch scope to another account.
- switched
From GetAccount Iam Api Key Scope Switched From Account - Permission for the Account from which user switched the scope.
- switched
To List<GetAccounts Iam Api Key Scope Switched To Account>
- account
Access stringControl Id - Moid of the AccountAccessControl through which the access is given to switch scope.
- additional
Properties string - class
Id 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.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- request
Identifier string - Stores the identifier of the issue for which user is trying to switch scope to another account.
- switched
From GetAccount Iam Api Key Scope Switched From Account - Permission for the Account from which user switched the scope.
- switched
To GetAccounts Iam Api Key Scope Switched To Account[]
- account_
access_ strcontrol_ id - 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_ Getaccount Iam Api Key Scope Switched From Account - Permission for the Account from which user switched the scope.
- switched_
to_ Sequence[Getaccounts Iam Api Key Scope Switched To Account]
- account
Access StringControl Id - Moid of the AccountAccessControl through which the access is given to switch scope.
- additional
Properties String - class
Id 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- request
Identifier String - Stores the identifier of the issue for which user is trying to switch scope to another account.
- switched
From Property MapAccount - Permission for the Account from which user switched the scope.
- switched
To List<Property Map>Accounts
GetIamApiKeyScopeSwitchedFromAccount
- Account
Id string - Moid of the Account to/from which user switched the scope.
- Additional
Properties string - Class
Id 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.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Permission
Id string - Moid of the Permission for the Account to/from which user switched the scope.
- Account
Id string - Moid of the Account to/from which user switched the scope.
- Additional
Properties string - Class
Id 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.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Permission
Id string - Moid of the Permission for the Account to/from which user switched the scope.
- account
Id String - Moid of the Account to/from which user switched the scope.
- additional
Properties String - class
Id 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- permission
Id String - Moid of the Permission for the Account to/from which user switched the scope.
- account
Id string - Moid of the Account to/from which user switched the scope.
- additional
Properties string - class
Id 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.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- permission
Id 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.
- account
Id String - Moid of the Account to/from which user switched the scope.
- additional
Properties String - class
Id 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- permission
Id String - Moid of the Permission for the Account to/from which user switched the scope.
GetIamApiKeyScopeSwitchedToAccount
- Account
Id string - Moid of the Account to/from which user switched the scope.
- Additional
Properties string - Class
Id 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.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Permission
Id string - Moid of the Permission for the Account to/from which user switched the scope.
- Account
Id string - Moid of the Account to/from which user switched the scope.
- Additional
Properties string - Class
Id 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.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Permission
Id string - Moid of the Permission for the Account to/from which user switched the scope.
- account
Id String - Moid of the Account to/from which user switched the scope.
- additional
Properties String - class
Id 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- permission
Id String - Moid of the Permission for the Account to/from which user switched the scope.
- account
Id string - Moid of the Account to/from which user switched the scope.
- additional
Properties string - class
Id 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.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- permission
Id 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.
- account
Id String - Moid of the Account to/from which user switched the scope.
- additional
Properties String - class
Id 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- permission
Id String - Moid of the Permission for the Account to/from which user switched the scope.
GetIamApiKeyTag
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
- additional
Properties 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.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
GetIamApiKeyUser
- Additional
Properties string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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
- Additional
Properties string - Class
Id 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.
- Interested
Mos List<GetIam Api Key Version Context Interested Mo> - Marked
For boolDeletion - 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 string - The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Ref
Mo GetIam Api Key Version Context Ref Mo - A reference to the original Managed Object.
- Timestamp string
- The time this versioned Managed Object was created.
- Version
Type 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 string - Class
Id 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.
- Interested
Mos []GetIam Api Key Version Context Interested Mo - Marked
For boolDeletion - 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 string - The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Ref
Mo GetIam Api Key Version Context Ref Mo - A reference to the original Managed Object.
- Timestamp string
- The time this versioned Managed Object was created.
- Version
Type 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 String - class
Id 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.
- interested
Mos List<GetIam Api Key Version Context Interested Mo> - marked
For BooleanDeletion - 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 String - The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- ref
Mo GetIam Api Key Version Context Ref Mo - A reference to the original Managed Object.
- timestamp String
- The time this versioned Managed Object was created.
- version
Type 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 string - class
Id 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.
- interested
Mos GetIam Api Key Version Context Interested Mo[] - marked
For booleanDeletion - 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 string - The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- ref
Mo GetIam Api Key Version Context Ref Mo - A reference to the original Managed Object.
- timestamp string
- The time this versioned Managed Object was created.
- version
Type 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[GetIam Api Key Version Context Interested Mo] - marked_
for_ booldeletion - 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 GetIam Api Key Version Context Ref Mo - 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.
- additional
Properties String - class
Id 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.
- interested
Mos List<Property Map> - marked
For BooleanDeletion - 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 String - The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- ref
Mo Property Map - A reference to the original Managed Object.
- timestamp String
- The time this versioned Managed Object was created.
- version
Type 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
- Additional
Properties string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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
- Additional
Properties string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - Class
Id 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.
- Object
Type 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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 string - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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.
- If 'moid' is set this field is ignored.
- 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 String - class
Id 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.
- object
Type 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.
- If 'moid' is set this field is ignored.
- 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.