Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.Identity.DomainsMyApiKey

This resource provides the My Api Key resource in Oracle Cloud Infrastructure Identity Domains service.

Add a user’s api key

Example Usage

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.DomainsMyApiKey;
import com.pulumi.oci.Identity.DomainsMyApiKeyArgs;
import com.pulumi.oci.Identity.inputs.DomainsMyApiKeyTagArgs;
import com.pulumi.oci.Identity.inputs.DomainsMyApiKeyUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testMyApiKey = new DomainsMyApiKey("testMyApiKey", DomainsMyApiKeyArgs.builder()        
            .idcsEndpoint(data.oci_identity_domain().test_domain().url())
            .key(var_.my_api_key_key())
            .schemas("urn:ietf:params:scim:schemas:oracle:idcs:apikey")
            .authorization(var_.my_api_key_authorization())
            .description(var_.my_api_key_description())
            .id(var_.my_api_key_id())
            .ocid(var_.my_api_key_ocid())
            .resourceTypeSchemaVersion(var_.my_api_key_resource_type_schema_version())
            .tags(DomainsMyApiKeyTagArgs.builder()
                .key(var_.my_api_key_tags_key())
                .value(var_.my_api_key_tags_value())
                .build())
            .user(DomainsMyApiKeyUserArgs.builder()
                .ocid(var_.my_api_key_user_ocid())
                .value(var_.my_api_key_user_value())
                .build())
            .build());

    }
}

Coming soon!

resources:
  testMyApiKey:
    type: oci:Identity:DomainsMyApiKey
    properties:
      #Required
      idcsEndpoint: ${data.oci_identity_domain.test_domain.url}
      key: ${var.my_api_key_key}
      schemas:
        - urn:ietf:params:scim:schemas:oracle:idcs:apikey
      #Optional
      authorization: ${var.my_api_key_authorization}
      description: ${var.my_api_key_description}
      id: ${var.my_api_key_id}
      ocid: ${var.my_api_key_ocid}
      resourceTypeSchemaVersion: ${var.my_api_key_resource_type_schema_version}
      tags:
        - key: ${var.my_api_key_tags_key}
          value: ${var.my_api_key_tags_value}
      user:
        ocid: ${var.my_api_key_user_ocid}
        value: ${var.my_api_key_user_value}

Create DomainsMyApiKey Resource

new DomainsMyApiKey(name: string, args: DomainsMyApiKeyArgs, opts?: CustomResourceOptions);

@overload
def DomainsMyApiKey(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    authorization: Optional[str] = None,
                    description: Optional[str] = None,
                    idcs_endpoint: Optional[str] = None,
                    key: Optional[str] = None,
                    ocid: Optional[str] = None,
                    resource_type_schema_version: Optional[str] = None,
                    schemas: Optional[Sequence[str]] = None,
                    tags: Optional[Sequence[_identity.DomainsMyApiKeyTagArgs]] = None,
                    user: Optional[_identity.DomainsMyApiKeyUserArgs] = None)
@overload
def DomainsMyApiKey(resource_name: str,
                    args: DomainsMyApiKeyArgs,
                    opts: Optional[ResourceOptions] = None)

func NewDomainsMyApiKey(ctx *Context, name string, args DomainsMyApiKeyArgs, opts ...ResourceOption) (*DomainsMyApiKey, error)

public DomainsMyApiKey(string name, DomainsMyApiKeyArgs args, CustomResourceOptions? opts = null)

public DomainsMyApiKey(String name, DomainsMyApiKeyArgs args)
public DomainsMyApiKey(String name, DomainsMyApiKeyArgs args, CustomResourceOptions options)

type: oci:Identity:DomainsMyApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainsMyApiKeyArgs: 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 DomainsMyApiKeyArgs: 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 DomainsMyApiKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainsMyApiKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DomainsMyApiKeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

DomainsMyApiKey Resource Properties

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

Inputs

The DomainsMyApiKey resource accepts the following input properties:

IdcsEndpoint string: The basic endpoint for the identity domain
Key string: Key or name of the tag.
Schemas List<string>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
Authorization string: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
Description string: Description
Ocid string: User's ocid
ResourceTypeSchemaVersion string: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Tags List<DomainsMyApiKeyTagArgs>: A list of tags on this resource.
User DomainsMyApiKeyUserArgs: User linked to api key

IdcsEndpoint string: The basic endpoint for the identity domain
Key string: Key or name of the tag.
Schemas []string: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
Authorization string: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
Description string: Description
Ocid string: User's ocid
ResourceTypeSchemaVersion string: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Tags []DomainsMyApiKeyTagArgs: A list of tags on this resource.
User DomainsMyApiKeyUserArgs: User linked to api key

idcsEndpoint String: The basic endpoint for the identity domain
key String: Key or name of the tag.
schemas List<String>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
authorization String: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
description String: Description
ocid String: User's ocid
resourceTypeSchemaVersion String: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
tags List<DomainsMyApiKeyTagArgs>: A list of tags on this resource.
user DomainsMyApiKeyUserArgs: User linked to api key

idcsEndpoint string: The basic endpoint for the identity domain
key string: Key or name of the tag.
schemas string[]: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
authorization string: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
description string: Description
ocid string: User's ocid
resourceTypeSchemaVersion string: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
tags DomainsMyApiKeyTagArgs[]: A list of tags on this resource.
user DomainsMyApiKeyUserArgs: User linked to api key

idcs_endpoint str: The basic endpoint for the identity domain
key str: Key or name of the tag.
schemas Sequence[str]: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
authorization str: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
description str: Description
ocid str: User's ocid
resource_type_schema_version str: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
tags DomainsMyApiKeyTagArgs]: A list of tags on this resource.
user DomainsMyApiKeyUserArgs: User linked to api key

idcsEndpoint String: The basic endpoint for the identity domain
key String: Key or name of the tag.
schemas List<String>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
authorization String: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
description String: Description
ocid String: User's ocid
resourceTypeSchemaVersion String: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
tags List<Property Map>: A list of tags on this resource.
user Property Map: User linked to api key

Outputs

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

CompartmentOcid string: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
DeleteInProgress bool: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
DomainOcid string: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
Fingerprint string: (Updatable) Fingerprint
Id string: The provider-assigned unique ID for this managed resource.
IdcsCreatedBies List<DomainsMyApiKeyIdcsCreatedBy>: (Updatable) The User or App who created the Resource
IdcsLastModifiedBies List<DomainsMyApiKeyIdcsLastModifiedBy>: (Updatable) The User or App who modified the Resource
IdcsLastUpgradedInRelease string: (Updatable) The release number when the resource was upgraded.
IdcsPreventedOperations List<string>: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Metas List<DomainsMyApiKeyMeta>: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
TenancyOcid string: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

CompartmentOcid string: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
DeleteInProgress bool: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
DomainOcid string: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
Fingerprint string: (Updatable) Fingerprint
Id string: The provider-assigned unique ID for this managed resource.
IdcsCreatedBies []DomainsMyApiKeyIdcsCreatedBy: (Updatable) The User or App who created the Resource
IdcsLastModifiedBies []DomainsMyApiKeyIdcsLastModifiedBy: (Updatable) The User or App who modified the Resource
IdcsLastUpgradedInRelease string: (Updatable) The release number when the resource was upgraded.
IdcsPreventedOperations []string: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Metas []DomainsMyApiKeyMeta: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
TenancyOcid string: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

compartmentOcid String: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress Boolean: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
domainOcid String: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint String: (Updatable) Fingerprint
id String: The provider-assigned unique ID for this managed resource.
idcsCreatedBies List<DomainsMyApiKeyIdcsCreatedBy>: (Updatable) The User or App who created the Resource
idcsLastModifiedBies List<DomainsMyApiKeyIdcsLastModifiedBy>: (Updatable) The User or App who modified the Resource
idcsLastUpgradedInRelease String: (Updatable) The release number when the resource was upgraded.
idcsPreventedOperations List<String>: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
metas List<DomainsMyApiKeyMeta>: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
tenancyOcid String: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

compartmentOcid string: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress boolean: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
domainOcid string: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint string: (Updatable) Fingerprint
id string: The provider-assigned unique ID for this managed resource.
idcsCreatedBies DomainsMyApiKeyIdcsCreatedBy[]: (Updatable) The User or App who created the Resource
idcsLastModifiedBies DomainsMyApiKeyIdcsLastModifiedBy[]: (Updatable) The User or App who modified the Resource
idcsLastUpgradedInRelease string: (Updatable) The release number when the resource was upgraded.
idcsPreventedOperations string[]: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
metas DomainsMyApiKeyMeta[]: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
tenancyOcid string: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

compartment_ocid str: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
delete_in_progress bool: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
domain_ocid str: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint str: (Updatable) Fingerprint
id str: The provider-assigned unique ID for this managed resource.
idcs_created_bies DomainsMyApiKeyIdcsCreatedBy]: (Updatable) The User or App who created the Resource
idcs_last_modified_bies DomainsMyApiKeyIdcsLastModifiedBy]: (Updatable) The User or App who modified the Resource
idcs_last_upgraded_in_release str: (Updatable) The release number when the resource was upgraded.
idcs_prevented_operations Sequence[str]: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
metas DomainsMyApiKeyMeta]: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
tenancy_ocid str: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

compartmentOcid String: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress Boolean: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
domainOcid String: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint String: (Updatable) Fingerprint
id String: The provider-assigned unique ID for this managed resource.
idcsCreatedBies List<Property Map>: (Updatable) The User or App who created the Resource
idcsLastModifiedBies List<Property Map>: (Updatable) The User or App who modified the Resource
idcsLastUpgradedInRelease String: (Updatable) The release number when the resource was upgraded.
idcsPreventedOperations List<String>: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
metas List<Property Map>: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
tenancyOcid String: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

Look up Existing DomainsMyApiKey Resource

Get an existing DomainsMyApiKey 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?: DomainsMyApiKeyState, opts?: CustomResourceOptions): DomainsMyApiKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization: Optional[str] = None,
        compartment_ocid: Optional[str] = None,
        delete_in_progress: Optional[bool] = None,
        description: Optional[str] = None,
        domain_ocid: Optional[str] = None,
        fingerprint: Optional[str] = None,
        idcs_created_bies: Optional[Sequence[_identity.DomainsMyApiKeyIdcsCreatedByArgs]] = None,
        idcs_endpoint: Optional[str] = None,
        idcs_last_modified_bies: Optional[Sequence[_identity.DomainsMyApiKeyIdcsLastModifiedByArgs]] = None,
        idcs_last_upgraded_in_release: Optional[str] = None,
        idcs_prevented_operations: Optional[Sequence[str]] = None,
        key: Optional[str] = None,
        metas: Optional[Sequence[_identity.DomainsMyApiKeyMetaArgs]] = None,
        ocid: Optional[str] = None,
        resource_type_schema_version: Optional[str] = None,
        schemas: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[_identity.DomainsMyApiKeyTagArgs]] = None,
        tenancy_ocid: Optional[str] = None,
        user: Optional[_identity.DomainsMyApiKeyUserArgs] = None) -> DomainsMyApiKey

func GetDomainsMyApiKey(ctx *Context, name string, id IDInput, state *DomainsMyApiKeyState, opts ...ResourceOption) (*DomainsMyApiKey, error)

public static DomainsMyApiKey Get(string name, Input<string> id, DomainsMyApiKeyState? state, CustomResourceOptions? opts = null)

public static DomainsMyApiKey get(String name, Output<String> id, DomainsMyApiKeyState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

Authorization string: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
CompartmentOcid string: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
DeleteInProgress bool: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
Description string: Description
DomainOcid string: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
Fingerprint string: (Updatable) Fingerprint
IdcsCreatedBies List<DomainsMyApiKeyIdcsCreatedByArgs>: (Updatable) The User or App who created the Resource
IdcsEndpoint string: The basic endpoint for the identity domain
IdcsLastModifiedBies List<DomainsMyApiKeyIdcsLastModifiedByArgs>: (Updatable) The User or App who modified the Resource
IdcsLastUpgradedInRelease string: (Updatable) The release number when the resource was upgraded.
IdcsPreventedOperations List<string>: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Key string: Key or name of the tag.
Metas List<DomainsMyApiKeyMetaArgs>: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
Ocid string: User's ocid
ResourceTypeSchemaVersion string: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Schemas List<string>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
Tags List<DomainsMyApiKeyTagArgs>: A list of tags on this resource.
TenancyOcid string: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
User DomainsMyApiKeyUserArgs: User linked to api key

Authorization string: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
CompartmentOcid string: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
DeleteInProgress bool: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
Description string: Description
DomainOcid string: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
Fingerprint string: (Updatable) Fingerprint
IdcsCreatedBies []DomainsMyApiKeyIdcsCreatedByArgs: (Updatable) The User or App who created the Resource
IdcsEndpoint string: The basic endpoint for the identity domain
IdcsLastModifiedBies []DomainsMyApiKeyIdcsLastModifiedByArgs: (Updatable) The User or App who modified the Resource
IdcsLastUpgradedInRelease string: (Updatable) The release number when the resource was upgraded.
IdcsPreventedOperations []string: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Key string: Key or name of the tag.
Metas []DomainsMyApiKeyMetaArgs: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
Ocid string: User's ocid
ResourceTypeSchemaVersion string: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Schemas []string: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
Tags []DomainsMyApiKeyTagArgs: A list of tags on this resource.
TenancyOcid string: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
User DomainsMyApiKeyUserArgs: User linked to api key

authorization String: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
compartmentOcid String: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress Boolean: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
description String: Description
domainOcid String: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint String: (Updatable) Fingerprint
idcsCreatedBies List<DomainsMyApiKeyIdcsCreatedByArgs>: (Updatable) The User or App who created the Resource
idcsEndpoint String: The basic endpoint for the identity domain
idcsLastModifiedBies List<DomainsMyApiKeyIdcsLastModifiedByArgs>: (Updatable) The User or App who modified the Resource
idcsLastUpgradedInRelease String: (Updatable) The release number when the resource was upgraded.
idcsPreventedOperations List<String>: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
key String: Key or name of the tag.
metas List<DomainsMyApiKeyMetaArgs>: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
ocid String: User's ocid
resourceTypeSchemaVersion String: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
schemas List<String>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
tags List<DomainsMyApiKeyTagArgs>: A list of tags on this resource.
tenancyOcid String: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
user DomainsMyApiKeyUserArgs: User linked to api key

authorization string: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
compartmentOcid string: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress boolean: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
description string: Description
domainOcid string: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint string: (Updatable) Fingerprint
idcsCreatedBies DomainsMyApiKeyIdcsCreatedByArgs[]: (Updatable) The User or App who created the Resource
idcsEndpoint string: The basic endpoint for the identity domain
idcsLastModifiedBies DomainsMyApiKeyIdcsLastModifiedByArgs[]: (Updatable) The User or App who modified the Resource
idcsLastUpgradedInRelease string: (Updatable) The release number when the resource was upgraded.
idcsPreventedOperations string[]: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
key string: Key or name of the tag.
metas DomainsMyApiKeyMetaArgs[]: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
ocid string: User's ocid
resourceTypeSchemaVersion string: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
schemas string[]: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
tags DomainsMyApiKeyTagArgs[]: A list of tags on this resource.
tenancyOcid string: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
user DomainsMyApiKeyUserArgs: User linked to api key

authorization str: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
compartment_ocid str: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
delete_in_progress bool: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
description str: Description
domain_ocid str: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint str: (Updatable) Fingerprint
idcs_created_bies DomainsMyApiKeyIdcsCreatedByArgs]: (Updatable) The User or App who created the Resource
idcs_endpoint str: The basic endpoint for the identity domain
idcs_last_modified_bies DomainsMyApiKeyIdcsLastModifiedByArgs]: (Updatable) The User or App who modified the Resource
idcs_last_upgraded_in_release str: (Updatable) The release number when the resource was upgraded.
idcs_prevented_operations Sequence[str]: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
key str: Key or name of the tag.
metas DomainsMyApiKeyMetaArgs]: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
ocid str: User's ocid
resource_type_schema_version str: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
schemas Sequence[str]: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
tags DomainsMyApiKeyTagArgs]: A list of tags on this resource.
tenancy_ocid str: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
user DomainsMyApiKeyUserArgs: User linked to api key

authorization String: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
compartmentOcid String: (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress Boolean: (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
description String: Description
domainOcid String: (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint String: (Updatable) Fingerprint
idcsCreatedBies List<Property Map>: (Updatable) The User or App who created the Resource
idcsEndpoint String: The basic endpoint for the identity domain
idcsLastModifiedBies List<Property Map>: (Updatable) The User or App who modified the Resource
idcsLastUpgradedInRelease String: (Updatable) The release number when the resource was upgraded.
idcsPreventedOperations List<String>: (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
key String: Key or name of the tag.
metas List<Property Map>: (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
ocid String: User's ocid
resourceTypeSchemaVersion String: An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
schemas List<String>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
tags List<Property Map>: A list of tags on this resource.
tenancyOcid String: (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
user Property Map: User linked to api key

Supporting Types

DomainsMyApiKeyIdcsCreatedBy

Value string: User's id
Display string: (Updatable) User display name
Ocid string: User's ocid
Ref string: (Updatable) The URI that corresponds to the user linked to this credential
Type string: The type of resource, User or App, that modified this Resource

Value string: User's id
Display string: (Updatable) User display name
Ocid string: User's ocid
Ref string: (Updatable) The URI that corresponds to the user linked to this credential
Type string: The type of resource, User or App, that modified this Resource

value String: User's id
display String: (Updatable) User display name
ocid String: User's ocid
ref String: (Updatable) The URI that corresponds to the user linked to this credential
type String: The type of resource, User or App, that modified this Resource

value string: User's id
display string: (Updatable) User display name
ocid string: User's ocid
ref string: (Updatable) The URI that corresponds to the user linked to this credential
type string: The type of resource, User or App, that modified this Resource

value str: User's id
display str: (Updatable) User display name
ocid str: User's ocid
ref str: (Updatable) The URI that corresponds to the user linked to this credential
type str: The type of resource, User or App, that modified this Resource

value String: User's id
display String: (Updatable) User display name
ocid String: User's ocid
ref String: (Updatable) The URI that corresponds to the user linked to this credential
type String: The type of resource, User or App, that modified this Resource

DomainsMyApiKeyIdcsLastModifiedBy

Value string: User's id
Display string: (Updatable) User display name
Ocid string: User's ocid
Ref string: (Updatable) The URI that corresponds to the user linked to this credential
Type string: The type of resource, User or App, that modified this Resource

Value string: User's id
Display string: (Updatable) User display name
Ocid string: User's ocid
Ref string: (Updatable) The URI that corresponds to the user linked to this credential
Type string: The type of resource, User or App, that modified this Resource

value String: User's id
display String: (Updatable) User display name
ocid String: User's ocid
ref String: (Updatable) The URI that corresponds to the user linked to this credential
type String: The type of resource, User or App, that modified this Resource

value string: User's id
display string: (Updatable) User display name
ocid string: User's ocid
ref string: (Updatable) The URI that corresponds to the user linked to this credential
type string: The type of resource, User or App, that modified this Resource

value str: User's id
display str: (Updatable) User display name
ocid str: User's ocid
ref str: (Updatable) The URI that corresponds to the user linked to this credential
type str: The type of resource, User or App, that modified this Resource

value String: User's id
display String: (Updatable) User display name
ocid String: User's ocid
ref String: (Updatable) The URI that corresponds to the user linked to this credential
type String: The type of resource, User or App, that modified this Resource

DomainsMyApiKeyMeta

Created string: The DateTime the Resource was added to the Service Provider
LastModified string: The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
Location string: The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
ResourceType string: Name of the resource type of the resource--for example, Users or Groups
Version string: The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

Created string: The DateTime the Resource was added to the Service Provider
LastModified string: The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
Location string: The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
ResourceType string: Name of the resource type of the resource--for example, Users or Groups
Version string: The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

created String: The DateTime the Resource was added to the Service Provider
lastModified String: The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
location String: The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
resourceType String: Name of the resource type of the resource--for example, Users or Groups
version String: The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

created string: The DateTime the Resource was added to the Service Provider
lastModified string: The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
location string: The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
resourceType string: Name of the resource type of the resource--for example, Users or Groups
version string: The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

created str: The DateTime the Resource was added to the Service Provider
last_modified str: The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
location str: The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
resource_type str: Name of the resource type of the resource--for example, Users or Groups
version str: The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

created String: The DateTime the Resource was added to the Service Provider
lastModified String: The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
location String: The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
resourceType String: Name of the resource type of the resource--for example, Users or Groups
version String: The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

DomainsMyApiKeyTag

Key string: Key or name of the tag.
Value string: User's id

Key string: Key or name of the tag.
Value string: User's id

key String: Key or name of the tag.
value String: User's id

key string: Key or name of the tag.
value string: User's id

key str: Key or name of the tag.
value str: User's id

key String: Key or name of the tag.
value String: User's id

DomainsMyApiKeyUser

Display string: (Updatable) User display name
Name string: (Updatable) User name
Ocid string: User's ocid
Ref string: (Updatable) The URI that corresponds to the user linked to this credential
Value string: User's id

Display string: (Updatable) User display name
Name string: (Updatable) User name
Ocid string: User's ocid
Ref string: (Updatable) The URI that corresponds to the user linked to this credential
Value string: User's id

display String: (Updatable) User display name
name String: (Updatable) User name
ocid String: User's ocid
ref String: (Updatable) The URI that corresponds to the user linked to this credential
value String: User's id

display string: (Updatable) User display name
name string: (Updatable) User name
ocid string: User's ocid
ref string: (Updatable) The URI that corresponds to the user linked to this credential
value string: User's id

display str: (Updatable) User display name
name str: (Updatable) User name
ocid str: User's ocid
ref str: (Updatable) The URI that corresponds to the user linked to this credential
value str: User's id

display String: (Updatable) User display name
name String: (Updatable) User name
ocid String: User's ocid
ref String: (Updatable) The URI that corresponds to the user linked to this credential
value String: User's id

Import

MyApiKeys can be imported using the id, e.g.

 $ pulumi import oci:Identity/domainsMyApiKey:DomainsMyApiKey test_my_api_key "idcsEndpoint/{idcsEndpoint}/myApiKeys/{myApiKeyId}"

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.