Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Intersight Provider
  3. API Docs
  4. IamApiKey
intersight 1.0.65 published on Wednesday, May 7, 2025 by ciscodevnet
ciscodevnet/terraform-provider-intersight

intersight.IamApiKey

Explore with Pulumi AI

intersight logo
intersight 1.0.65 published on Wednesday, May 7, 2025 by ciscodevnet
ciscodevnet/terraform-provider-intersight

    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.

    Allowed Types in AdditionalProperties

    pkix.EcdsaKeySpec

    The key pair is generated using Elliptic Curve Digital Signature Algorithm (ECDSA), as defined in FIPS 186-4. The ECDSA standard was originally developed for the American National Standards Institute by the Accredited Standards Committee on Financial Services, X9. ANS X9.62 defines methods for digital signature generation and verification using ECDSA. Specifications for the generation of the domain parameters used during the generation and verification of digital signatures are also included in ANS X9.62.

    • curve:(string) A specific set of Elliptic Curve parameters, as recommended by NIST in FIPS 186-4.* P256 - P256 returns a Curve which implements P-256, as defined in FIPS 186-4, section D.2.3.* P224 - P224 returns a Curve which implements P-224, as defined in FIPS 186-4, section D.2.2.* P384 - P384 returns a Curve which implements P-384, as defined in FIPS 186-4, section D.2.4.* P521 - P521 returns a Curve which implements P-521, as defined in FIPS 186-4, section D.2.5.

    pkix.EddsaKeySpec

    The key pair is generated using Edwards-Curve Digital Signature Algorithm (EdDSA). The Edwards-curve Digital Signature Algorithm (EdDSA) is a variant of Schnorr’s signature system with (possibly twisted) Edwards curves.

    • algorithm:(string) The EdDSA algorithm, as defined in RFC 8032.* Ed25519 - The edwards25519 curve, as defined in RFC 8032 section 5.1.* Ed25519ph - The edwards25519 curve for the PureEdDSA variant.* Ed25519ctx - The edwards25519 curve for the HashEdDSA variant.

    pkix.RsaAlgorithm

    The key pair is generated using the RSA algorithm and specified parameters.

    • modulus:(int) The length of the RSA key, expressed in bits, for both public and private keys.* 2048 - A key length of 2048 bits.* 2560 - A key length of 2560 bits.* 3072 - A key length of 3072 bits.* 3584 - A key length of 3584 bits.* 4096 - A key length of 4096 bits.

    Create IamApiKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IamApiKey(name: string, args?: IamApiKeyArgs, opts?: CustomResourceOptions);
    @overload
def IamApiKey(resource_name: str,
              args: Optional[IamApiKeyArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def IamApiKey(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              account_moid: Optional[str] = None,
              additional_properties: Optional[str] = None,
              admin_status: Optional[str] = None,
              ancestors: Optional[Sequence[IamApiKeyAncestorArgs]] = 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,
              iam_api_key_id: Optional[str] = None,
              is_never_expiring: Optional[bool] = None,
              key_specs: Optional[Sequence[IamApiKeyKeySpecArgs]] = 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,
              parents: Optional[Sequence[IamApiKeyParentArgs]] = None,
              permission_resources: Optional[Sequence[IamApiKeyPermissionResourceArgs]] = None,
              permissions: Optional[Sequence[IamApiKeyPermissionArgs]] = None,
              private_key: Optional[str] = None,
              purpose: Optional[str] = None,
              scopes: Optional[Sequence[IamApiKeyScopeArgs]] = None,
              shared_scope: Optional[str] = None,
              signing_algorithm: Optional[str] = None,
              start_time: Optional[str] = None,
              tags: Optional[Sequence[IamApiKeyTagArgs]] = None,
              users: Optional[Sequence[IamApiKeyUserArgs]] = None,
              version_contexts: Optional[Sequence[IamApiKeyVersionContextArgs]] = None)
    func NewIamApiKey(ctx *Context, name string, args *IamApiKeyArgs, opts ...ResourceOption) (*IamApiKey, error)
    public IamApiKey(string name, IamApiKeyArgs? args = null, CustomResourceOptions? opts = null)
    public IamApiKey(String name, IamApiKeyArgs args)
public IamApiKey(String name, IamApiKeyArgs args, CustomResourceOptions options)

    type: intersight:IamApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IamApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IamApiKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IamApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamApiKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var iamApiKeyResource = new Intersight.IamApiKey("iamApiKeyResource", new()
{
    AccountMoid = "string",
    AdditionalProperties = "string",
    AdminStatus = "string",
    Ancestors = new[]
    {
        new Intersight.Inputs.IamApiKeyAncestorArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    ClassId = "string",
    CreateTime = "string",
    DomainGroupMoid = "string",
    ExpiryDateTime = "string",
    HashAlgorithm = "string",
    IamApiKeyId = "string",
    IsNeverExpiring = false,
    KeySpecs = new[]
    {
        new Intersight.Inputs.IamApiKeyKeySpecArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Name = "string",
            ObjectType = "string",
        },
    },
    LastUsedIp = "string",
    LastUsedTime = "string",
    ModTime = "string",
    Moid = "string",
    ObjectType = "string",
    OperStatus = "string",
    Owners = new[]
    {
        "string",
    },
    Parents = new[]
    {
        new Intersight.Inputs.IamApiKeyParentArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    PermissionResources = new[]
    {
        new Intersight.Inputs.IamApiKeyPermissionResourceArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    Permissions = new[]
    {
        new Intersight.Inputs.IamApiKeyPermissionArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    PrivateKey = "string",
    Purpose = "string",
    Scopes = new[]
    {
        new Intersight.Inputs.IamApiKeyScopeArgs
        {
            AccountAccessControlId = "string",
            AdditionalProperties = "string",
            ClassId = "string",
            ObjectType = "string",
            RequestIdentifier = "string",
            SwitchedFromAccounts = new[]
            {
                new Intersight.Inputs.IamApiKeyScopeSwitchedFromAccountArgs
                {
                    AccountId = "string",
                    AdditionalProperties = "string",
                    ClassId = "string",
                    ObjectType = "string",
                    PermissionId = "string",
                },
            },
            SwitchedToAccounts = new[]
            {
                new Intersight.Inputs.IamApiKeyScopeSwitchedToAccountArgs
                {
                    AccountId = "string",
                    AdditionalProperties = "string",
                    ClassId = "string",
                    ObjectType = "string",
                    PermissionId = "string",
                },
            },
        },
    },
    SharedScope = "string",
    SigningAlgorithm = "string",
    StartTime = "string",
    Tags = new[]
    {
        new Intersight.Inputs.IamApiKeyTagArgs
        {
            AdditionalProperties = "string",
            Key = "string",
            Value = "string",
        },
    },
    Users = new[]
    {
        new Intersight.Inputs.IamApiKeyUserArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    VersionContexts = new[]
    {
        new Intersight.Inputs.IamApiKeyVersionContextArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            InterestedMos = new[]
            {
                new Intersight.Inputs.IamApiKeyVersionContextInterestedMoArgs
                {
                    AdditionalProperties = "string",
                    ClassId = "string",
                    Moid = "string",
                    ObjectType = "string",
                    Selector = "string",
                },
            },
            MarkedForDeletion = false,
            NrVersion = "string",
            ObjectType = "string",
            RefMos = new[]
            {
                new Intersight.Inputs.IamApiKeyVersionContextRefMoArgs
                {
                    AdditionalProperties = "string",
                    ClassId = "string",
                    Moid = "string",
                    ObjectType = "string",
                    Selector = "string",
                },
            },
            Timestamp = "string",
            VersionType = "string",
        },
    },
});

    example, err := intersight.NewIamApiKey(ctx, "iamApiKeyResource", &intersight.IamApiKeyArgs{
	AccountMoid:          pulumi.String("string"),
	AdditionalProperties: pulumi.String("string"),
	AdminStatus:          pulumi.String("string"),
	Ancestors: intersight.IamApiKeyAncestorArray{
		&intersight.IamApiKeyAncestorArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	ClassId:         pulumi.String("string"),
	CreateTime:      pulumi.String("string"),
	DomainGroupMoid: pulumi.String("string"),
	ExpiryDateTime:  pulumi.String("string"),
	HashAlgorithm:   pulumi.String("string"),
	IamApiKeyId:     pulumi.String("string"),
	IsNeverExpiring: pulumi.Bool(false),
	KeySpecs: intersight.IamApiKeyKeySpecArray{
		&intersight.IamApiKeyKeySpecArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Name:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
		},
	},
	LastUsedIp:   pulumi.String("string"),
	LastUsedTime: pulumi.String("string"),
	ModTime:      pulumi.String("string"),
	Moid:         pulumi.String("string"),
	ObjectType:   pulumi.String("string"),
	OperStatus:   pulumi.String("string"),
	Owners: pulumi.StringArray{
		pulumi.String("string"),
	},
	Parents: intersight.IamApiKeyParentArray{
		&intersight.IamApiKeyParentArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	PermissionResources: intersight.IamApiKeyPermissionResourceArray{
		&intersight.IamApiKeyPermissionResourceArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	Permissions: intersight.IamApiKeyPermissionArray{
		&intersight.IamApiKeyPermissionArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	PrivateKey: pulumi.String("string"),
	Purpose:    pulumi.String("string"),
	Scopes: intersight.IamApiKeyScopeArray{
		&intersight.IamApiKeyScopeArgs{
			AccountAccessControlId: pulumi.String("string"),
			AdditionalProperties:   pulumi.String("string"),
			ClassId:                pulumi.String("string"),
			ObjectType:             pulumi.String("string"),
			RequestIdentifier:      pulumi.String("string"),
			SwitchedFromAccounts: intersight.IamApiKeyScopeSwitchedFromAccountArray{
				&intersight.IamApiKeyScopeSwitchedFromAccountArgs{
					AccountId:            pulumi.String("string"),
					AdditionalProperties: pulumi.String("string"),
					ClassId:              pulumi.String("string"),
					ObjectType:           pulumi.String("string"),
					PermissionId:         pulumi.String("string"),
				},
			},
			SwitchedToAccounts: intersight.IamApiKeyScopeSwitchedToAccountArray{
				&intersight.IamApiKeyScopeSwitchedToAccountArgs{
					AccountId:            pulumi.String("string"),
					AdditionalProperties: pulumi.String("string"),
					ClassId:              pulumi.String("string"),
					ObjectType:           pulumi.String("string"),
					PermissionId:         pulumi.String("string"),
				},
			},
		},
	},
	SharedScope:      pulumi.String("string"),
	SigningAlgorithm: pulumi.String("string"),
	StartTime:        pulumi.String("string"),
	Tags: intersight.IamApiKeyTagArray{
		&intersight.IamApiKeyTagArgs{
			AdditionalProperties: pulumi.String("string"),
			Key:                  pulumi.String("string"),
			Value:                pulumi.String("string"),
		},
	},
	Users: intersight.IamApiKeyUserArray{
		&intersight.IamApiKeyUserArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	VersionContexts: intersight.IamApiKeyVersionContextArray{
		&intersight.IamApiKeyVersionContextArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			InterestedMos: intersight.IamApiKeyVersionContextInterestedMoArray{
				&intersight.IamApiKeyVersionContextInterestedMoArgs{
					AdditionalProperties: pulumi.String("string"),
					ClassId:              pulumi.String("string"),
					Moid:                 pulumi.String("string"),
					ObjectType:           pulumi.String("string"),
					Selector:             pulumi.String("string"),
				},
			},
			MarkedForDeletion: pulumi.Bool(false),
			NrVersion:         pulumi.String("string"),
			ObjectType:        pulumi.String("string"),
			RefMos: intersight.IamApiKeyVersionContextRefMoArray{
				&intersight.IamApiKeyVersionContextRefMoArgs{
					AdditionalProperties: pulumi.String("string"),
					ClassId:              pulumi.String("string"),
					Moid:                 pulumi.String("string"),
					ObjectType:           pulumi.String("string"),
					Selector:             pulumi.String("string"),
				},
			},
			Timestamp:   pulumi.String("string"),
			VersionType: pulumi.String("string"),
		},
	},
})

    var iamApiKeyResource = new IamApiKey("iamApiKeyResource", IamApiKeyArgs.builder()
    .accountMoid("string")
    .additionalProperties("string")
    .adminStatus("string")
    .ancestors(IamApiKeyAncestorArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .classId("string")
    .createTime("string")
    .domainGroupMoid("string")
    .expiryDateTime("string")
    .hashAlgorithm("string")
    .iamApiKeyId("string")
    .isNeverExpiring(false)
    .keySpecs(IamApiKeyKeySpecArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .name("string")
        .objectType("string")
        .build())
    .lastUsedIp("string")
    .lastUsedTime("string")
    .modTime("string")
    .moid("string")
    .objectType("string")
    .operStatus("string")
    .owners("string")
    .parents(IamApiKeyParentArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .permissionResources(IamApiKeyPermissionResourceArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .permissions(IamApiKeyPermissionArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .privateKey("string")
    .purpose("string")
    .scopes(IamApiKeyScopeArgs.builder()
        .accountAccessControlId("string")
        .additionalProperties("string")
        .classId("string")
        .objectType("string")
        .requestIdentifier("string")
        .switchedFromAccounts(IamApiKeyScopeSwitchedFromAccountArgs.builder()
            .accountId("string")
            .additionalProperties("string")
            .classId("string")
            .objectType("string")
            .permissionId("string")
            .build())
        .switchedToAccounts(IamApiKeyScopeSwitchedToAccountArgs.builder()
            .accountId("string")
            .additionalProperties("string")
            .classId("string")
            .objectType("string")
            .permissionId("string")
            .build())
        .build())
    .sharedScope("string")
    .signingAlgorithm("string")
    .startTime("string")
    .tags(IamApiKeyTagArgs.builder()
        .additionalProperties("string")
        .key("string")
        .value("string")
        .build())
    .users(IamApiKeyUserArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .versionContexts(IamApiKeyVersionContextArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .interestedMos(IamApiKeyVersionContextInterestedMoArgs.builder()
            .additionalProperties("string")
            .classId("string")
            .moid("string")
            .objectType("string")
            .selector("string")
            .build())
        .markedForDeletion(false)
        .nrVersion("string")
        .objectType("string")
        .refMos(IamApiKeyVersionContextRefMoArgs.builder()
            .additionalProperties("string")
            .classId("string")
            .moid("string")
            .objectType("string")
            .selector("string")
            .build())
        .timestamp("string")
        .versionType("string")
        .build())
    .build());

    iam_api_key_resource = intersight.IamApiKey("iamApiKeyResource",
    account_moid="string",
    additional_properties="string",
    admin_status="string",
    ancestors=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    class_id="string",
    create_time="string",
    domain_group_moid="string",
    expiry_date_time="string",
    hash_algorithm="string",
    iam_api_key_id="string",
    is_never_expiring=False,
    key_specs=[{
        "additional_properties": "string",
        "class_id": "string",
        "name": "string",
        "object_type": "string",
    }],
    last_used_ip="string",
    last_used_time="string",
    mod_time="string",
    moid="string",
    object_type="string",
    oper_status="string",
    owners=["string"],
    parents=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    permission_resources=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    permissions=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    private_key="string",
    purpose="string",
    scopes=[{
        "account_access_control_id": "string",
        "additional_properties": "string",
        "class_id": "string",
        "object_type": "string",
        "request_identifier": "string",
        "switched_from_accounts": [{
            "account_id": "string",
            "additional_properties": "string",
            "class_id": "string",
            "object_type": "string",
            "permission_id": "string",
        }],
        "switched_to_accounts": [{
            "account_id": "string",
            "additional_properties": "string",
            "class_id": "string",
            "object_type": "string",
            "permission_id": "string",
        }],
    }],
    shared_scope="string",
    signing_algorithm="string",
    start_time="string",
    tags=[{
        "additional_properties": "string",
        "key": "string",
        "value": "string",
    }],
    users=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    version_contexts=[{
        "additional_properties": "string",
        "class_id": "string",
        "interested_mos": [{
            "additional_properties": "string",
            "class_id": "string",
            "moid": "string",
            "object_type": "string",
            "selector": "string",
        }],
        "marked_for_deletion": False,
        "nr_version": "string",
        "object_type": "string",
        "ref_mos": [{
            "additional_properties": "string",
            "class_id": "string",
            "moid": "string",
            "object_type": "string",
            "selector": "string",
        }],
        "timestamp": "string",
        "version_type": "string",
    }])

    const iamApiKeyResource = new intersight.IamApiKey("iamApiKeyResource", {
    accountMoid: "string",
    additionalProperties: "string",
    adminStatus: "string",
    ancestors: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    classId: "string",
    createTime: "string",
    domainGroupMoid: "string",
    expiryDateTime: "string",
    hashAlgorithm: "string",
    iamApiKeyId: "string",
    isNeverExpiring: false,
    keySpecs: [{
        additionalProperties: "string",
        classId: "string",
        name: "string",
        objectType: "string",
    }],
    lastUsedIp: "string",
    lastUsedTime: "string",
    modTime: "string",
    moid: "string",
    objectType: "string",
    operStatus: "string",
    owners: ["string"],
    parents: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    permissionResources: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    permissions: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    privateKey: "string",
    purpose: "string",
    scopes: [{
        accountAccessControlId: "string",
        additionalProperties: "string",
        classId: "string",
        objectType: "string",
        requestIdentifier: "string",
        switchedFromAccounts: [{
            accountId: "string",
            additionalProperties: "string",
            classId: "string",
            objectType: "string",
            permissionId: "string",
        }],
        switchedToAccounts: [{
            accountId: "string",
            additionalProperties: "string",
            classId: "string",
            objectType: "string",
            permissionId: "string",
        }],
    }],
    sharedScope: "string",
    signingAlgorithm: "string",
    startTime: "string",
    tags: [{
        additionalProperties: "string",
        key: "string",
        value: "string",
    }],
    users: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    versionContexts: [{
        additionalProperties: "string",
        classId: "string",
        interestedMos: [{
            additionalProperties: "string",
            classId: "string",
            moid: "string",
            objectType: "string",
            selector: "string",
        }],
        markedForDeletion: false,
        nrVersion: "string",
        objectType: "string",
        refMos: [{
            additionalProperties: "string",
            classId: "string",
            moid: "string",
            objectType: "string",
            selector: "string",
        }],
        timestamp: "string",
        versionType: "string",
    }],
});

    type: intersight:IamApiKey
properties:
    accountMoid: string
    additionalProperties: string
    adminStatus: string
    ancestors:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    classId: string
    createTime: string
    domainGroupMoid: string
    expiryDateTime: string
    hashAlgorithm: string
    iamApiKeyId: string
    isNeverExpiring: false
    keySpecs:
        - additionalProperties: string
          classId: string
          name: string
          objectType: string
    lastUsedIp: string
    lastUsedTime: string
    modTime: string
    moid: string
    objectType: string
    operStatus: string
    owners:
        - string
    parents:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    permissionResources:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    permissions:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    privateKey: string
    purpose: string
    scopes:
        - accountAccessControlId: string
          additionalProperties: string
          classId: string
          objectType: string
          requestIdentifier: string
          switchedFromAccounts:
            - accountId: string
              additionalProperties: string
              classId: string
              objectType: string
              permissionId: string
          switchedToAccounts:
            - accountId: string
              additionalProperties: string
              classId: string
              objectType: string
              permissionId: string
    sharedScope: string
    signingAlgorithm: string
    startTime: string
    tags:
        - additionalProperties: string
          key: string
          value: string
    users:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    versionContexts:
        - additionalProperties: string
          classId: string
          interestedMos:
            - additionalProperties: string
              classId: string
              moid: string
              objectType: string
              selector: string
          markedForDeletion: false
          nrVersion: string
          objectType: string
          refMos:
            - additionalProperties: string
              classId: string
              moid: string
              objectType: string
              selector: string
          timestamp: string
          versionType: string

    IamApiKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IamApiKey resource accepts the following input properties:

    AccountMoid string
    (ReadOnly) The Account ID for this managed object.
    AdditionalProperties string
    AdminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    Ancestors List<IamApiKeyAncestor>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    CreateTime string
    (ReadOnly) The time when this managed object was created.
    DomainGroupMoid string
    (ReadOnly) The DomainGroup ID for this managed object.
    ExpiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    HashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    IamApiKeyId string
    IsNeverExpiring bool
    Used to mark the API key as a never-expiring API key.
    KeySpecs List<IamApiKeyKeySpec>
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    LastUsedIp string
    (ReadOnly) The IP address from which the API key was last used.
    LastUsedTime string
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    ModTime string
    (ReadOnly) The time when this managed object was last modified.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    OperStatus string
    (ReadOnly) 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>
    (Array of schema.TypeString) -(ReadOnly)
    Parents List<IamApiKeyParent>
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    PermissionResources List<IamApiKeyPermissionResource>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    Permissions List<IamApiKeyPermission>
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    PrivateKey string
    Holds the private key for the API key.
    Purpose string
    The purpose of the API Key.
    Scopes List<IamApiKeyScope>
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    SharedScope string
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    SigningAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    StartTime string
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    Tags List<IamApiKeyTag>
    This complex property has following sub-properties:
    Users List<IamApiKeyUser>
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    VersionContexts List<IamApiKeyVersionContext>
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    AccountMoid string
    (ReadOnly) The Account ID for this managed object.
    AdditionalProperties string
    AdminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    Ancestors []IamApiKeyAncestorArgs
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    CreateTime string
    (ReadOnly) The time when this managed object was created.
    DomainGroupMoid string
    (ReadOnly) The DomainGroup ID for this managed object.
    ExpiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    HashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    IamApiKeyId string
    IsNeverExpiring bool
    Used to mark the API key as a never-expiring API key.
    KeySpecs []IamApiKeyKeySpecArgs
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    LastUsedIp string
    (ReadOnly) The IP address from which the API key was last used.
    LastUsedTime string
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    ModTime string
    (ReadOnly) The time when this managed object was last modified.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    OperStatus string
    (ReadOnly) 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
    (Array of schema.TypeString) -(ReadOnly)
    Parents []IamApiKeyParentArgs
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    PermissionResources []IamApiKeyPermissionResourceArgs
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    Permissions []IamApiKeyPermissionArgs
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    PrivateKey string
    Holds the private key for the API key.
    Purpose string
    The purpose of the API Key.
    Scopes []IamApiKeyScopeArgs
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    SharedScope string
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    SigningAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    StartTime string
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    Tags []IamApiKeyTagArgs
    This complex property has following sub-properties:
    Users []IamApiKeyUserArgs
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    VersionContexts []IamApiKeyVersionContextArgs
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    accountMoid String
    (ReadOnly) The Account ID for this managed object.
    additionalProperties String
    adminStatus String
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors List<IamApiKeyAncestor>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    createTime String
    (ReadOnly) The time when this managed object was created.
    domainGroupMoid String
    (ReadOnly) The DomainGroup ID for this managed object.
    expiryDateTime String
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm String
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    iamApiKeyId String
    isNeverExpiring Boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs List<IamApiKeyKeySpec>
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    lastUsedIp String
    (ReadOnly) The IP address from which the API key was last used.
    lastUsedTime String
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    modTime String
    (ReadOnly) The time when this managed object was last modified.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    operStatus String
    (ReadOnly) 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>
    (Array of schema.TypeString) -(ReadOnly)
    parents List<IamApiKeyParent>
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    permissionResources List<IamApiKeyPermissionResource>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    permissions List<IamApiKeyPermission>
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    privateKey String
    Holds the private key for the API key.
    purpose String
    The purpose of the API Key.
    scopes List<IamApiKeyScope>
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    sharedScope String
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm String
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime String
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags List<IamApiKeyTag>
    This complex property has following sub-properties:
    users List<IamApiKeyUser>
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    versionContexts List<IamApiKeyVersionContext>
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    accountMoid string
    (ReadOnly) The Account ID for this managed object.
    additionalProperties string
    adminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors IamApiKeyAncestor[]
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    createTime string
    (ReadOnly) The time when this managed object was created.
    domainGroupMoid string
    (ReadOnly) The DomainGroup ID for this managed object.
    expiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    iamApiKeyId string
    isNeverExpiring boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs IamApiKeyKeySpec[]
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    lastUsedIp string
    (ReadOnly) The IP address from which the API key was last used.
    lastUsedTime string
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    modTime string
    (ReadOnly) The time when this managed object was last modified.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    operStatus string
    (ReadOnly) 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[]
    (Array of schema.TypeString) -(ReadOnly)
    parents IamApiKeyParent[]
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    permissionResources IamApiKeyPermissionResource[]
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    permissions IamApiKeyPermission[]
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    privateKey string
    Holds the private key for the API key.
    purpose string
    The purpose of the API Key.
    scopes IamApiKeyScope[]
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    sharedScope string
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime string
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags IamApiKeyTag[]
    This complex property has following sub-properties:
    users IamApiKeyUser[]
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    versionContexts IamApiKeyVersionContext[]
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    account_moid str
    (ReadOnly) 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[IamApiKeyAncestorArgs]
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    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.
    create_time str
    (ReadOnly) The time when this managed object was created.
    domain_group_moid str
    (ReadOnly) The DomainGroup ID for this managed object.
    expiry_date_time str
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hash_algorithm str
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    iam_api_key_id str
    is_never_expiring bool
    Used to mark the API key as a never-expiring API key.
    key_specs Sequence[IamApiKeyKeySpecArgs]
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    last_used_ip str
    (ReadOnly) The IP address from which the API key was last used.
    last_used_time str
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    mod_time str
    (ReadOnly) The time when this managed object was last modified.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    oper_status str
    (ReadOnly) 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]
    (Array of schema.TypeString) -(ReadOnly)
    parents Sequence[IamApiKeyParentArgs]
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    permission_resources Sequence[IamApiKeyPermissionResourceArgs]
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    permissions Sequence[IamApiKeyPermissionArgs]
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    private_key str
    Holds the private key for the API key.
    purpose str
    The purpose of the API Key.
    scopes Sequence[IamApiKeyScopeArgs]
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    shared_scope str
    (ReadOnly) 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
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags Sequence[IamApiKeyTagArgs]
    This complex property has following sub-properties:
    users Sequence[IamApiKeyUserArgs]
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    version_contexts Sequence[IamApiKeyVersionContextArgs]
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    accountMoid String
    (ReadOnly) The Account ID for this managed object.
    additionalProperties String
    adminStatus String
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors List<Property Map>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    createTime String
    (ReadOnly) The time when this managed object was created.
    domainGroupMoid String
    (ReadOnly) The DomainGroup ID for this managed object.
    expiryDateTime String
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm String
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    iamApiKeyId String
    isNeverExpiring Boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs List<Property Map>
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    lastUsedIp String
    (ReadOnly) The IP address from which the API key was last used.
    lastUsedTime String
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    modTime String
    (ReadOnly) The time when this managed object was last modified.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    operStatus String
    (ReadOnly) 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>
    (Array of schema.TypeString) -(ReadOnly)
    parents List<Property Map>
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    permissionResources List<Property Map>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    permissions List<Property Map>
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    privateKey String
    Holds the private key for the API key.
    purpose String
    The purpose of the API Key.
    scopes List<Property Map>
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    sharedScope String
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm String
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime String
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags List<Property Map>
    This complex property has following sub-properties:
    users List<Property Map>
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    versionContexts List<Property Map>
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IamApiKey resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IamApiKey Resource

    Get an existing IamApiKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IamApiKeyState, opts?: CustomResourceOptions): IamApiKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_moid: Optional[str] = None,
        additional_properties: Optional[str] = None,
        admin_status: Optional[str] = None,
        ancestors: Optional[Sequence[IamApiKeyAncestorArgs]] = 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,
        iam_api_key_id: Optional[str] = None,
        is_never_expiring: Optional[bool] = None,
        key_specs: Optional[Sequence[IamApiKeyKeySpecArgs]] = 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,
        parents: Optional[Sequence[IamApiKeyParentArgs]] = None,
        permission_resources: Optional[Sequence[IamApiKeyPermissionResourceArgs]] = None,
        permissions: Optional[Sequence[IamApiKeyPermissionArgs]] = None,
        private_key: Optional[str] = None,
        purpose: Optional[str] = None,
        scopes: Optional[Sequence[IamApiKeyScopeArgs]] = None,
        shared_scope: Optional[str] = None,
        signing_algorithm: Optional[str] = None,
        start_time: Optional[str] = None,
        tags: Optional[Sequence[IamApiKeyTagArgs]] = None,
        users: Optional[Sequence[IamApiKeyUserArgs]] = None,
        version_contexts: Optional[Sequence[IamApiKeyVersionContextArgs]] = None) -> IamApiKey
    func GetIamApiKey(ctx *Context, name string, id IDInput, state *IamApiKeyState, opts ...ResourceOption) (*IamApiKey, error)
    public static IamApiKey Get(string name, Input<string> id, IamApiKeyState? state, CustomResourceOptions? opts = null)
    public static IamApiKey get(String name, Output<String> id, IamApiKeyState state, CustomResourceOptions options)
    resources:  _:    type: intersight:IamApiKey    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountMoid string
    (ReadOnly) The Account ID for this managed object.
    AdditionalProperties string
    AdminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    Ancestors List<IamApiKeyAncestor>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    CreateTime string
    (ReadOnly) The time when this managed object was created.
    DomainGroupMoid string
    (ReadOnly) The DomainGroup ID for this managed object.
    ExpiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    HashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    IamApiKeyId string
    IsNeverExpiring bool
    Used to mark the API key as a never-expiring API key.
    KeySpecs List<IamApiKeyKeySpec>
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    LastUsedIp string
    (ReadOnly) The IP address from which the API key was last used.
    LastUsedTime string
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    ModTime string
    (ReadOnly) The time when this managed object was last modified.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    OperStatus string
    (ReadOnly) 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>
    (Array of schema.TypeString) -(ReadOnly)
    Parents List<IamApiKeyParent>
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    PermissionResources List<IamApiKeyPermissionResource>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    Permissions List<IamApiKeyPermission>
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    PrivateKey string
    Holds the private key for the API key.
    Purpose string
    The purpose of the API Key.
    Scopes List<IamApiKeyScope>
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    SharedScope string
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    SigningAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    StartTime string
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    Tags List<IamApiKeyTag>
    This complex property has following sub-properties:
    Users List<IamApiKeyUser>
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    VersionContexts List<IamApiKeyVersionContext>
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    AccountMoid string
    (ReadOnly) The Account ID for this managed object.
    AdditionalProperties string
    AdminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    Ancestors []IamApiKeyAncestorArgs
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    ClassId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    CreateTime string
    (ReadOnly) The time when this managed object was created.
    DomainGroupMoid string
    (ReadOnly) The DomainGroup ID for this managed object.
    ExpiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    HashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    IamApiKeyId string
    IsNeverExpiring bool
    Used to mark the API key as a never-expiring API key.
    KeySpecs []IamApiKeyKeySpecArgs
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    LastUsedIp string
    (ReadOnly) The IP address from which the API key was last used.
    LastUsedTime string
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    ModTime string
    (ReadOnly) The time when this managed object was last modified.
    Moid string
    The unique identifier of this Managed Object instance.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    OperStatus string
    (ReadOnly) 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
    (Array of schema.TypeString) -(ReadOnly)
    Parents []IamApiKeyParentArgs
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    PermissionResources []IamApiKeyPermissionResourceArgs
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    Permissions []IamApiKeyPermissionArgs
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    PrivateKey string
    Holds the private key for the API key.
    Purpose string
    The purpose of the API Key.
    Scopes []IamApiKeyScopeArgs
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    SharedScope string
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    SigningAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    StartTime string
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    Tags []IamApiKeyTagArgs
    This complex property has following sub-properties:
    Users []IamApiKeyUserArgs
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    VersionContexts []IamApiKeyVersionContextArgs
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    accountMoid String
    (ReadOnly) The Account ID for this managed object.
    additionalProperties String
    adminStatus String
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors List<IamApiKeyAncestor>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    createTime String
    (ReadOnly) The time when this managed object was created.
    domainGroupMoid String
    (ReadOnly) The DomainGroup ID for this managed object.
    expiryDateTime String
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm String
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    iamApiKeyId String
    isNeverExpiring Boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs List<IamApiKeyKeySpec>
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    lastUsedIp String
    (ReadOnly) The IP address from which the API key was last used.
    lastUsedTime String
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    modTime String
    (ReadOnly) The time when this managed object was last modified.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    operStatus String
    (ReadOnly) 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>
    (Array of schema.TypeString) -(ReadOnly)
    parents List<IamApiKeyParent>
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    permissionResources List<IamApiKeyPermissionResource>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    permissions List<IamApiKeyPermission>
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    privateKey String
    Holds the private key for the API key.
    purpose String
    The purpose of the API Key.
    scopes List<IamApiKeyScope>
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    sharedScope String
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm String
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime String
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags List<IamApiKeyTag>
    This complex property has following sub-properties:
    users List<IamApiKeyUser>
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    versionContexts List<IamApiKeyVersionContext>
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    accountMoid string
    (ReadOnly) The Account ID for this managed object.
    additionalProperties string
    adminStatus string
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors IamApiKeyAncestor[]
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    classId string
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    createTime string
    (ReadOnly) The time when this managed object was created.
    domainGroupMoid string
    (ReadOnly) The DomainGroup ID for this managed object.
    expiryDateTime string
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm string
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    iamApiKeyId string
    isNeverExpiring boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs IamApiKeyKeySpec[]
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    lastUsedIp string
    (ReadOnly) The IP address from which the API key was last used.
    lastUsedTime string
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    modTime string
    (ReadOnly) The time when this managed object was last modified.
    moid string
    The unique identifier of this Managed Object instance.
    objectType string
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    operStatus string
    (ReadOnly) 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[]
    (Array of schema.TypeString) -(ReadOnly)
    parents IamApiKeyParent[]
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    permissionResources IamApiKeyPermissionResource[]
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    permissions IamApiKeyPermission[]
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    privateKey string
    Holds the private key for the API key.
    purpose string
    The purpose of the API Key.
    scopes IamApiKeyScope[]
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    sharedScope string
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm string
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime string
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags IamApiKeyTag[]
    This complex property has following sub-properties:
    users IamApiKeyUser[]
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    versionContexts IamApiKeyVersionContext[]
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    account_moid str
    (ReadOnly) 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[IamApiKeyAncestorArgs]
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    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.
    create_time str
    (ReadOnly) The time when this managed object was created.
    domain_group_moid str
    (ReadOnly) The DomainGroup ID for this managed object.
    expiry_date_time str
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hash_algorithm str
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    iam_api_key_id str
    is_never_expiring bool
    Used to mark the API key as a never-expiring API key.
    key_specs Sequence[IamApiKeyKeySpecArgs]
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    last_used_ip str
    (ReadOnly) The IP address from which the API key was last used.
    last_used_time str
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    mod_time str
    (ReadOnly) The time when this managed object was last modified.
    moid str
    The unique identifier of this Managed Object instance.
    object_type str
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    oper_status str
    (ReadOnly) 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]
    (Array of schema.TypeString) -(ReadOnly)
    parents Sequence[IamApiKeyParentArgs]
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    permission_resources Sequence[IamApiKeyPermissionResourceArgs]
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    permissions Sequence[IamApiKeyPermissionArgs]
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    private_key str
    Holds the private key for the API key.
    purpose str
    The purpose of the API Key.
    scopes Sequence[IamApiKeyScopeArgs]
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    shared_scope str
    (ReadOnly) 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
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags Sequence[IamApiKeyTagArgs]
    This complex property has following sub-properties:
    users Sequence[IamApiKeyUserArgs]
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    version_contexts Sequence[IamApiKeyVersionContextArgs]
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
    accountMoid String
    (ReadOnly) The Account ID for this managed object.
    additionalProperties String
    adminStatus String
    Used to trigger the enable or disable action on the API key. These actions change the status of an API key.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
    ancestors List<Property Map>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    classId String
    The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
    createTime String
    (ReadOnly) The time when this managed object was created.
    domainGroupMoid String
    (ReadOnly) The DomainGroup ID for this managed object.
    expiryDateTime String
    The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
    hashAlgorithm String
    The cryptographic hash algorithm to calculate the message digest.* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
    iamApiKeyId String
    isNeverExpiring Boolean
    Used to mark the API key as a never-expiring API key.
    keySpecs List<Property Map>
    The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA). This complex property has following sub-properties:
    lastUsedIp String
    (ReadOnly) The IP address from which the API key was last used.
    lastUsedTime String
    (ReadOnly) The time at which the API key was last used. It is updated every 24 hours.
    modTime String
    (ReadOnly) The time when this managed object was last modified.
    moid String
    The unique identifier of this Managed Object instance.
    objectType String
    The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
    operStatus String
    (ReadOnly) 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>
    (Array of schema.TypeString) -(ReadOnly)
    parents List<Property Map>
    (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    permissionResources List<Property Map>
    (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
    permissions List<Property Map>
    (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    privateKey String
    Holds the private key for the API key.
    purpose String
    The purpose of the API Key.
    scopes List<Property Map>
    (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
    sharedScope String
    (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
    signingAlgorithm String
    The signing algorithm used by the client to authenticate API requests to Intersight.The signing algorithm must be compatible with the key generation specification.* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
    startTime String
    (ReadOnly) The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.
    tags List<Property Map>
    This complex property has following sub-properties:
    users List<Property Map>
    (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
    versionContexts List<Property Map>
    (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:

    Supporting Types

    IamApiKeyAncestor, IamApiKeyAncestorArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    moid string
    The Moid of the referenced REST resource.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    moid str
    The Moid of the referenced REST resource.
    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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.

    IamApiKeyKeySpec, IamApiKeyKeySpecArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Name string
    (ReadOnly) Name of the key generation algorithm.* RSA - Key pairs should be generated by the RSA algorithm.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Name string
    (ReadOnly) Name of the key generation algorithm.* RSA - Key pairs should be generated by the RSA algorithm.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    name String
    (ReadOnly) Name of the key generation algorithm.* RSA - Key pairs should be generated by the RSA algorithm.
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    name string
    (ReadOnly) Name of the key generation algorithm.* RSA - Key pairs should be generated by the RSA algorithm.
    objectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
    additional_properties str
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    name str
    (ReadOnly) Name of the key generation algorithm.* RSA - Key pairs should be generated by the RSA algorithm.
    object_type str
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    name String
    (ReadOnly) Name of the key generation algorithm.* RSA - Key pairs should be generated by the RSA algorithm.
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.

    IamApiKeyParent, IamApiKeyParentArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    moid string
    The Moid of the referenced REST resource.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    moid str
    The Moid of the referenced REST resource.
    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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.

    IamApiKeyPermission, IamApiKeyPermissionArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    moid string
    The Moid of the referenced REST resource.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    moid str
    The Moid of the referenced REST resource.
    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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.

    IamApiKeyPermissionResource, IamApiKeyPermissionResourceArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    moid string
    The Moid of the referenced REST resource.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    moid str
    The Moid of the referenced REST resource.
    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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.

    IamApiKeyScope, IamApiKeyScopeArgs

    AccountAccessControlId string
    (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    RequestIdentifier string
    (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
    SwitchedFromAccounts List<IamApiKeyScopeSwitchedFromAccount>
    (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
    SwitchedToAccounts List<IamApiKeyScopeSwitchedToAccount>
    This complex property has following sub-properties:
    AccountAccessControlId string
    (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    RequestIdentifier string
    (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
    SwitchedFromAccounts []IamApiKeyScopeSwitchedFromAccount
    (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
    SwitchedToAccounts []IamApiKeyScopeSwitchedToAccount
    This complex property has following sub-properties:
    accountAccessControlId String
    (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    requestIdentifier String
    (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
    switchedFromAccounts List<IamApiKeyScopeSwitchedFromAccount>
    (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
    switchedToAccounts List<IamApiKeyScopeSwitchedToAccount>
    This complex property has following sub-properties:
    accountAccessControlId string
    (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    objectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    requestIdentifier string
    (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
    switchedFromAccounts IamApiKeyScopeSwitchedFromAccount[]
    (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
    switchedToAccounts IamApiKeyScopeSwitchedToAccount[]
    This complex property has following sub-properties:
    account_access_control_id str
    (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
    additional_properties str
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    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
    (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
    switched_from_accounts Sequence[IamApiKeyScopeSwitchedFromAccount]
    (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
    switched_to_accounts Sequence[IamApiKeyScopeSwitchedToAccount]
    This complex property has following sub-properties:
    accountAccessControlId String
    (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    requestIdentifier String
    (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
    switchedFromAccounts List<Property Map>
    (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
    switchedToAccounts List<Property Map>
    This complex property has following sub-properties:

    IamApiKeyScopeSwitchedFromAccount, IamApiKeyScopeSwitchedFromAccountArgs

    AccountId string
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    PermissionId string
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    AccountId string
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    PermissionId string
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    accountId String
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    permissionId String
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    accountId string
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    objectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    permissionId string
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    account_id str
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    additional_properties str
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    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
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    accountId String
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    permissionId String
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.

    IamApiKeyScopeSwitchedToAccount, IamApiKeyScopeSwitchedToAccountArgs

    AccountId string
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    PermissionId string
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    AccountId string
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    PermissionId string
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    accountId String
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    permissionId String
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    accountId string
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    objectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    permissionId string
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    account_id str
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    additional_properties str
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    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
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
    accountId String
    (ReadOnly) Moid of the Account to/from which user switched the scope.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    permissionId String
    (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.

    IamApiKeyTag, IamApiKeyTagArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    Key string
    The string representation of a tag key.
    Value string
    The string representation of a tag value.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    Key string
    The string representation of a tag key.
    Value string
    The string representation of a tag value.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    key String
    The string representation of a tag key.
    value String
    The string representation of a tag value.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    key string
    The string representation of a tag key.
    value string
    The string representation of a tag value.
    additional_properties str
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    key str
    The string representation of a tag key.
    value str
    The string representation of a tag value.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    key String
    The string representation of a tag key.
    value String
    The string representation of a tag value.

    IamApiKeyUser, IamApiKeyUserArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    moid string
    The Moid of the referenced REST resource.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    moid str
    The Moid of the referenced REST resource.
    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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.

    IamApiKeyVersionContext, IamApiKeyVersionContextArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    InterestedMos List<IamApiKeyVersionContextInterestedMo>
    This complex property has following sub-properties:
    MarkedForDeletion bool
    (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    NrVersion string
    (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    RefMos List<IamApiKeyVersionContextRefMo>
    (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
    Timestamp string
    (ReadOnly) The time this versioned Managed Object was created.
    VersionType string
    (ReadOnly) 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 intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    InterestedMos []IamApiKeyVersionContextInterestedMo
    This complex property has following sub-properties:
    MarkedForDeletion bool
    (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    NrVersion string
    (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
    ObjectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    RefMos []IamApiKeyVersionContextRefMo
    (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
    Timestamp string
    (ReadOnly) The time this versioned Managed Object was created.
    VersionType string
    (ReadOnly) 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 intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    interestedMos List<IamApiKeyVersionContextInterestedMo>
    This complex property has following sub-properties:
    markedForDeletion Boolean
    (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    nrVersion String
    (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    refMos List<IamApiKeyVersionContextRefMo>
    (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
    timestamp String
    (ReadOnly) The time this versioned Managed Object was created.
    versionType String
    (ReadOnly) 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 intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    interestedMos IamApiKeyVersionContextInterestedMo[]
    This complex property has following sub-properties:
    markedForDeletion boolean
    (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    nrVersion string
    (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
    objectType string
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    refMos IamApiKeyVersionContextRefMo[]
    (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
    timestamp string
    (ReadOnly) The time this versioned Managed Object was created.
    versionType string
    (ReadOnly) 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 intendedto 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
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    interested_mos Sequence[IamApiKeyVersionContextInterestedMo]
    This complex property has following sub-properties:
    marked_for_deletion bool
    (ReadOnly) 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
    (ReadOnly) 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_mos Sequence[IamApiKeyVersionContextRefMo]
    (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
    timestamp str
    (ReadOnly) The time this versioned Managed Object was created.
    version_type str
    (ReadOnly) 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 intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    interestedMos List<Property Map>
    This complex property has following sub-properties:
    markedForDeletion Boolean
    (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
    nrVersion String
    (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
    objectType String
    The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
    refMos List<Property Map>
    (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
    timestamp String
    (ReadOnly) The time this versioned Managed Object was created.
    versionType String
    (ReadOnly) 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 intendedto 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.

    IamApiKeyVersionContextInterestedMo, IamApiKeyVersionContextInterestedMoArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    moid string
    The Moid of the referenced REST resource.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    moid str
    The Moid of the referenced REST resource.
    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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.

    IamApiKeyVersionContextRefMo, IamApiKeyVersionContextRefMoArgs

    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    AdditionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    ClassId string
    Moid string
    The Moid of the referenced REST resource.
    ObjectType string
    The fully-qualified name of the remote type referred by this relationship.
    Selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties string
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId string
    moid string
    The Moid of the referenced REST resource.
    objectType string
    The fully-qualified name of the remote type referred by this relationship.
    selector string
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    class_id str
    moid str
    The Moid of the referenced REST resource.
    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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
    additionalProperties String
    Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: pkix.EcdsaKeySpec pkix.EddsaKeySpec pkix.RsaAlgorithm
    classId String
    moid String
    The Moid of the referenced REST resource.
    objectType String
    The fully-qualified name of the remote type referred by this relationship.
    selector String
    An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.

    Import

    intersight_iam_api_key can be imported using the Moid of the object, e.g.

    $ pulumi import intersight:index/iamApiKey:IamApiKey example 1234567890987654321abcde

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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