1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. DomainsApiKey
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.Identity.DomainsApiKey

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

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

    Create a user’s API key.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      testApiKey:
        type: oci:Identity:DomainsApiKey
        name: test_api_key
        properties:
          idcsEndpoint: ${testDomain.url}
          key: ${apiKeyKey}
          schemas:
            - urn:ietf:params:scim:schemas:oracle:idcs:apikey
          attributeSets: []
          attributes:
          authorization: ${apiKeyAuthorization}
          description: ${apiKeyDescription}
          id: ${apiKeyId}
          ocid: ${apiKeyOcid}
          resourceTypeSchemaVersion: ${apiKeyResourceTypeSchemaVersion}
          tags:
            - key: ${apiKeyTagsKey}
              value: ${apiKeyTagsValue}
          urnietfparamsscimschemasoracleidcsextensionselfChangeUser:
            allowSelfChange: ${apiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserAllowSelfChange}
          user:
            ocid: ${testUser.ocid}
            value: ${testUser.id}
    

    Create DomainsApiKey Resource

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

    Constructor syntax

    new DomainsApiKey(name: string, args: DomainsApiKeyArgs, opts?: CustomResourceOptions);
    @overload
    def DomainsApiKey(resource_name: str,
                      args: DomainsApiKeyArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def DomainsApiKey(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      idcs_endpoint: Optional[str] = None,
                      key: Optional[str] = None,
                      schemas: Optional[Sequence[str]] = None,
                      attribute_sets: Optional[Sequence[str]] = None,
                      attributes: Optional[str] = None,
                      authorization: Optional[str] = None,
                      description: Optional[str] = None,
                      ocid: Optional[str] = None,
                      resource_type_schema_version: Optional[str] = None,
                      tags: Optional[Sequence[_identity.DomainsApiKeyTagArgs]] = None,
                      urnietfparamsscimschemasoracleidcsextensionself_change_user: Optional[_identity.DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs] = None,
                      user: Optional[_identity.DomainsApiKeyUserArgs] = None)
    func NewDomainsApiKey(ctx *Context, name string, args DomainsApiKeyArgs, opts ...ResourceOption) (*DomainsApiKey, error)
    public DomainsApiKey(string name, DomainsApiKeyArgs args, CustomResourceOptions? opts = null)
    public DomainsApiKey(String name, DomainsApiKeyArgs args)
    public DomainsApiKey(String name, DomainsApiKeyArgs args, CustomResourceOptions options)
    
    type: oci:Identity:DomainsApiKey
    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 DomainsApiKeyArgs
    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 DomainsApiKeyArgs
    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 DomainsApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainsApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainsApiKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var domainsApiKeyResource = new Oci.Identity.DomainsApiKey("domainsApiKeyResource", new()
    {
        IdcsEndpoint = "string",
        Key = "string",
        Schemas = new[]
        {
            "string",
        },
        AttributeSets = new[]
        {
            "string",
        },
        Attributes = "string",
        Authorization = "string",
        Description = "string",
        Ocid = "string",
        ResourceTypeSchemaVersion = "string",
        Tags = new[]
        {
            new Oci.Identity.Inputs.DomainsApiKeyTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        UrnietfparamsscimschemasoracleidcsextensionselfChangeUser = new Oci.Identity.Inputs.DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs
        {
            AllowSelfChange = false,
        },
        User = new Oci.Identity.Inputs.DomainsApiKeyUserArgs
        {
            Display = "string",
            Name = "string",
            Ocid = "string",
            Ref = "string",
            Value = "string",
        },
    });
    
    example, err := Identity.NewDomainsApiKey(ctx, "domainsApiKeyResource", &Identity.DomainsApiKeyArgs{
    	IdcsEndpoint: pulumi.String("string"),
    	Key:          pulumi.String("string"),
    	Schemas: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AttributeSets: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Attributes:                pulumi.String("string"),
    	Authorization:             pulumi.String("string"),
    	Description:               pulumi.String("string"),
    	Ocid:                      pulumi.String("string"),
    	ResourceTypeSchemaVersion: pulumi.String("string"),
    	Tags: identity.DomainsApiKeyTagArray{
    		&identity.DomainsApiKeyTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	UrnietfparamsscimschemasoracleidcsextensionselfChangeUser: &identity.DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs{
    		AllowSelfChange: pulumi.Bool(false),
    	},
    	User: &identity.DomainsApiKeyUserArgs{
    		Display: pulumi.String("string"),
    		Name:    pulumi.String("string"),
    		Ocid:    pulumi.String("string"),
    		Ref:     pulumi.String("string"),
    		Value:   pulumi.String("string"),
    	},
    })
    
    var domainsApiKeyResource = new DomainsApiKey("domainsApiKeyResource", DomainsApiKeyArgs.builder()
        .idcsEndpoint("string")
        .key("string")
        .schemas("string")
        .attributeSets("string")
        .attributes("string")
        .authorization("string")
        .description("string")
        .ocid("string")
        .resourceTypeSchemaVersion("string")
        .tags(DomainsApiKeyTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .urnietfparamsscimschemasoracleidcsextensionselfChangeUser(DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs.builder()
            .allowSelfChange(false)
            .build())
        .user(DomainsApiKeyUserArgs.builder()
            .display("string")
            .name("string")
            .ocid("string")
            .ref("string")
            .value("string")
            .build())
        .build());
    
    domains_api_key_resource = oci.identity.DomainsApiKey("domainsApiKeyResource",
        idcs_endpoint="string",
        key="string",
        schemas=["string"],
        attribute_sets=["string"],
        attributes="string",
        authorization="string",
        description="string",
        ocid="string",
        resource_type_schema_version="string",
        tags=[oci.identity.DomainsApiKeyTagArgs(
            key="string",
            value="string",
        )],
        urnietfparamsscimschemasoracleidcsextensionself_change_user=oci.identity.DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs(
            allow_self_change=False,
        ),
        user=oci.identity.DomainsApiKeyUserArgs(
            display="string",
            name="string",
            ocid="string",
            ref="string",
            value="string",
        ))
    
    const domainsApiKeyResource = new oci.identity.DomainsApiKey("domainsApiKeyResource", {
        idcsEndpoint: "string",
        key: "string",
        schemas: ["string"],
        attributeSets: ["string"],
        attributes: "string",
        authorization: "string",
        description: "string",
        ocid: "string",
        resourceTypeSchemaVersion: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        urnietfparamsscimschemasoracleidcsextensionselfChangeUser: {
            allowSelfChange: false,
        },
        user: {
            display: "string",
            name: "string",
            ocid: "string",
            ref: "string",
            value: "string",
        },
    });
    
    type: oci:Identity:DomainsApiKey
    properties:
        attributeSets:
            - string
        attributes: string
        authorization: string
        description: string
        idcsEndpoint: string
        key: string
        ocid: string
        resourceTypeSchemaVersion: string
        schemas:
            - string
        tags:
            - key: string
              value: string
        urnietfparamsscimschemasoracleidcsextensionselfChangeUser:
            allowSelfChange: false
        user:
            display: string
            name: string
            ocid: string
            ref: string
            value: string
    

    DomainsApiKey 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 DomainsApiKey resource accepts the following input properties:

    IdcsEndpoint string
    The basic endpoint for the identity domain
    Key string

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    AttributeSets List<string>
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    Attributes string
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    Ocid string

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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<DomainsApiKeyTag>

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    UrnietfparamsscimschemasoracleidcsextensionselfChangeUser DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser
    Controls whether a user can update themselves or not via User related APIs
    User DomainsApiKeyUser

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    IdcsEndpoint string
    The basic endpoint for the identity domain
    Key string

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    AttributeSets []string
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    Attributes string
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    Ocid string

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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 []DomainsApiKeyTagArgs

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    UrnietfparamsscimschemasoracleidcsextensionselfChangeUser DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs
    Controls whether a user can update themselves or not via User related APIs
    User DomainsApiKeyUserArgs

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    idcsEndpoint String
    The basic endpoint for the identity domain
    key String

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    attributeSets List<String>
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    attributes String
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    ocid String

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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<DomainsApiKeyTag>

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    urnietfparamsscimschemasoracleidcsextensionselfChangeUser DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser
    Controls whether a user can update themselves or not via User related APIs
    user DomainsApiKeyUser

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    idcsEndpoint string
    The basic endpoint for the identity domain
    key string

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    attributeSets string[]
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    attributes string
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    ocid string

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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 DomainsApiKeyTag[]

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    urnietfparamsscimschemasoracleidcsextensionselfChangeUser DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser
    Controls whether a user can update themselves or not via User related APIs
    user DomainsApiKeyUser

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    idcs_endpoint str
    The basic endpoint for the identity domain
    key str

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    attribute_sets Sequence[str]
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    attributes str
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    ocid str

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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 Sequence[identity.DomainsApiKeyTagArgs]

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    urnietfparamsscimschemasoracleidcsextensionself_change_user identity.DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs
    Controls whether a user can update themselves or not via User related APIs
    user identity.DomainsApiKeyUserArgs

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    idcsEndpoint String
    The basic endpoint for the identity domain
    key String

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    attributeSets List<String>
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    attributes String
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    ocid String

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    urnietfparamsscimschemasoracleidcsextensionselfChangeUser Property Map
    Controls whether a user can update themselves or not via User related APIs
    user Property Map

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none

    Outputs

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

    CompartmentOcid string

    (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    DomainOcid string

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Fingerprint string

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    Id string
    The provider-assigned unique ID for this managed resource.
    IdcsCreatedBies List<DomainsApiKeyIdcsCreatedBy>

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    IdcsLastModifiedBies List<DomainsApiKeyIdcsLastModifiedBy>

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    IdcsLastUpgradedInRelease string

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    IdcsPreventedOperations List<string>

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Metas List<DomainsApiKeyMeta>

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    TenancyOcid string

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    CompartmentOcid string

    (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    DomainOcid string

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Fingerprint string

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    Id string
    The provider-assigned unique ID for this managed resource.
    IdcsCreatedBies []DomainsApiKeyIdcsCreatedBy

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    IdcsLastModifiedBies []DomainsApiKeyIdcsLastModifiedBy

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    IdcsLastUpgradedInRelease string

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    IdcsPreventedOperations []string

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Metas []DomainsApiKeyMeta

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    TenancyOcid string

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    compartmentOcid String

    (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    domainOcid String

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    fingerprint String

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    id String
    The provider-assigned unique ID for this managed resource.
    idcsCreatedBies List<DomainsApiKeyIdcsCreatedBy>

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    idcsLastModifiedBies List<DomainsApiKeyIdcsLastModifiedBy>

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    idcsLastUpgradedInRelease String

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    idcsPreventedOperations List<String>

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    metas List<DomainsApiKeyMeta>

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    tenancyOcid String

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    compartmentOcid string

    (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    domainOcid string

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    fingerprint string

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    id string
    The provider-assigned unique ID for this managed resource.
    idcsCreatedBies DomainsApiKeyIdcsCreatedBy[]

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    idcsLastModifiedBies DomainsApiKeyIdcsLastModifiedBy[]

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    idcsLastUpgradedInRelease string

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    idcsPreventedOperations string[]

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    metas DomainsApiKeyMeta[]

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    tenancyOcid string

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    compartment_ocid str

    (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    domain_ocid str

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    fingerprint str

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    id str
    The provider-assigned unique ID for this managed resource.
    idcs_created_bies Sequence[identity.DomainsApiKeyIdcsCreatedBy]

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    idcs_last_modified_bies Sequence[identity.DomainsApiKeyIdcsLastModifiedBy]

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    idcs_last_upgraded_in_release str

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    metas Sequence[identity.DomainsApiKeyMeta]

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    tenancy_ocid str

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    compartmentOcid String

    (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    domainOcid String

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    fingerprint String

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    id String
    The provider-assigned unique ID for this managed resource.
    idcsCreatedBies List<Property Map>

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    idcsLastModifiedBies List<Property Map>

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    idcsLastUpgradedInRelease String

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    idcsPreventedOperations List<String>

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    metas List<Property Map>

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    tenancyOcid String

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

    Look up Existing DomainsApiKey Resource

    Get an existing DomainsApiKey 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?: DomainsApiKeyState, opts?: CustomResourceOptions): DomainsApiKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attribute_sets: Optional[Sequence[str]] = None,
            attributes: Optional[str] = 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.DomainsApiKeyIdcsCreatedByArgs]] = None,
            idcs_endpoint: Optional[str] = None,
            idcs_last_modified_bies: Optional[Sequence[_identity.DomainsApiKeyIdcsLastModifiedByArgs]] = None,
            idcs_last_upgraded_in_release: Optional[str] = None,
            idcs_prevented_operations: Optional[Sequence[str]] = None,
            key: Optional[str] = None,
            metas: Optional[Sequence[_identity.DomainsApiKeyMetaArgs]] = None,
            ocid: Optional[str] = None,
            resource_type_schema_version: Optional[str] = None,
            schemas: Optional[Sequence[str]] = None,
            tags: Optional[Sequence[_identity.DomainsApiKeyTagArgs]] = None,
            tenancy_ocid: Optional[str] = None,
            urnietfparamsscimschemasoracleidcsextensionself_change_user: Optional[_identity.DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs] = None,
            user: Optional[_identity.DomainsApiKeyUserArgs] = None) -> DomainsApiKey
    func GetDomainsApiKey(ctx *Context, name string, id IDInput, state *DomainsApiKeyState, opts ...ResourceOption) (*DomainsApiKey, error)
    public static DomainsApiKey Get(string name, Input<string> id, DomainsApiKeyState? state, CustomResourceOptions? opts = null)
    public static DomainsApiKey get(String name, Output<String> id, DomainsApiKeyState 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:
    AttributeSets List<string>
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    Attributes string
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Description string

    Description

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    DomainOcid string

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Fingerprint string

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    IdcsCreatedBies List<DomainsApiKeyIdcsCreatedBy>

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    IdcsEndpoint string
    The basic endpoint for the identity domain
    IdcsLastModifiedBies List<DomainsApiKeyIdcsLastModifiedBy>

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    IdcsLastUpgradedInRelease string

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    IdcsPreventedOperations List<string>

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Key string

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    Metas List<DomainsApiKeyMeta>

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    Ocid string

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Tags List<DomainsApiKeyTag>

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    TenancyOcid string

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    UrnietfparamsscimschemasoracleidcsextensionselfChangeUser DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser
    Controls whether a user can update themselves or not via User related APIs
    User DomainsApiKeyUser

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    AttributeSets []string
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    Attributes string
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Description string

    Description

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    DomainOcid string

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Fingerprint string

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    IdcsCreatedBies []DomainsApiKeyIdcsCreatedByArgs

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    IdcsEndpoint string
    The basic endpoint for the identity domain
    IdcsLastModifiedBies []DomainsApiKeyIdcsLastModifiedByArgs

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    IdcsLastUpgradedInRelease string

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    IdcsPreventedOperations []string

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Key string

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    Metas []DomainsApiKeyMetaArgs

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    Ocid string

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Tags []DomainsApiKeyTagArgs

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    TenancyOcid string

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    UrnietfparamsscimschemasoracleidcsextensionselfChangeUser DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs
    Controls whether a user can update themselves or not via User related APIs
    User DomainsApiKeyUserArgs

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    attributeSets List<String>
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    attributes String
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    description String

    Description

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    domainOcid String

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    fingerprint String

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    idcsCreatedBies List<DomainsApiKeyIdcsCreatedBy>

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    idcsEndpoint String
    The basic endpoint for the identity domain
    idcsLastModifiedBies List<DomainsApiKeyIdcsLastModifiedBy>

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    idcsLastUpgradedInRelease String

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    idcsPreventedOperations List<String>

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    key String

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    metas List<DomainsApiKeyMeta>

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    ocid String

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    tags List<DomainsApiKeyTag>

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    tenancyOcid String

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    urnietfparamsscimschemasoracleidcsextensionselfChangeUser DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser
    Controls whether a user can update themselves or not via User related APIs
    user DomainsApiKeyUser

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    attributeSets string[]
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    attributes string
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    description string

    Description

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    domainOcid string

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    fingerprint string

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    idcsCreatedBies DomainsApiKeyIdcsCreatedBy[]

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    idcsEndpoint string
    The basic endpoint for the identity domain
    idcsLastModifiedBies DomainsApiKeyIdcsLastModifiedBy[]

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    idcsLastUpgradedInRelease string

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    idcsPreventedOperations string[]

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    key string

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    metas DomainsApiKeyMeta[]

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    ocid string

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    tags DomainsApiKeyTag[]

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    tenancyOcid string

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    urnietfparamsscimschemasoracleidcsextensionselfChangeUser DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser
    Controls whether a user can update themselves or not via User related APIs
    user DomainsApiKeyUser

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    attribute_sets Sequence[str]
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    attributes str
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    description str

    Description

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    domain_ocid str

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    fingerprint str

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    idcs_created_bies Sequence[identity.DomainsApiKeyIdcsCreatedByArgs]

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    idcs_endpoint str
    The basic endpoint for the identity domain
    idcs_last_modified_bies Sequence[identity.DomainsApiKeyIdcsLastModifiedByArgs]

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    idcs_last_upgraded_in_release str

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    key str

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    metas Sequence[identity.DomainsApiKeyMetaArgs]

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    ocid str

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    tags Sequence[identity.DomainsApiKeyTagArgs]

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    tenancy_ocid str

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    urnietfparamsscimschemasoracleidcsextensionself_change_user identity.DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs
    Controls whether a user can update themselves or not via User related APIs
    user identity.DomainsApiKeyUserArgs

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    attributeSets List<String>
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    attributes String
    A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    description String

    Description

    Added In: 2101262133

    SCIM++ Properties:

    • caseExact: false
    • type: string
    • mutability: readWrite
    • required: false
    • returned: default
    domainOcid String

    (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    fingerprint String

    (Updatable) Fingerprint

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • type: string
    • mutability: readOnly
    • required: true
    • returned: default
    idcsCreatedBies List<Property Map>

    (Updatable) The User or App who created the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    idcsEndpoint String
    The basic endpoint for the identity domain
    idcsLastModifiedBies List<Property Map>

    (Updatable) The User or App who modified the Resource

    SCIM++ Properties:

    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    idcsLastUpgradedInRelease String

    (Updatable) The release number when the resource was upgraded.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    idcsPreventedOperations List<String>

    (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    key String

    Key

    Added In: 2010242156

    SCIM++ Properties:

    • caseExact: true
    • idcsPii: true
    • type: string
    • mutability: immutable
    • required: true
    • returned: default
    metas List<Property Map>

    (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    ocid String

    Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    tags List<Property Map>

    A list of tags on this resource.

    SCIM++ Properties:

    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    tenancyOcid String

    (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    urnietfparamsscimschemasoracleidcsextensionselfChangeUser Property Map
    Controls whether a user can update themselves or not via User related APIs
    user Property Map

    The user linked to the API key.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none

    Supporting Types

    DomainsApiKeyIdcsCreatedBy, DomainsApiKeyIdcsCreatedByArgs

    Value string

    The ID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Display string

    The displayName of the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Ocid string

    The OCID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    Ref string

    (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Type string

    The type of resource, User or App, that created this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Value string

    The ID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Display string

    The displayName of the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Ocid string

    The OCID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    Ref string

    (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Type string

    The type of resource, User or App, that created this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    value String

    The ID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    display String

    The displayName of the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid String

    The OCID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    ref String

    (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    type String

    The type of resource, User or App, that created this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    value string

    The ID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    display string

    The displayName of the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid string

    The OCID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    ref string

    (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    type string

    The type of resource, User or App, that created this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    value str

    The ID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    display str

    The displayName of the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid str

    The OCID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    ref str

    (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    type str

    The type of resource, User or App, that created this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    value String

    The ID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    display String

    The displayName of the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid String

    The OCID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    ref String

    (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    type String

    The type of resource, User or App, that created this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

    DomainsApiKeyIdcsLastModifiedBy, DomainsApiKeyIdcsLastModifiedByArgs

    Value string

    The ID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Display string

    The displayName of the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Ocid string

    The OCID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    Ref string

    (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Type string

    The type of resource, User or App, that modified this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Value string

    The ID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Display string

    The displayName of the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Ocid string

    The OCID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    Ref string

    (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Type string

    The type of resource, User or App, that modified this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    value String

    The ID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    display String

    The displayName of the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid String

    The OCID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    ref String

    (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    type String

    The type of resource, User or App, that modified this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    value string

    The ID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    display string

    The displayName of the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid string

    The OCID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    ref string

    (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    type string

    The type of resource, User or App, that modified this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    value str

    The ID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    display str

    The displayName of the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid str

    The OCID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    ref str

    (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    type str

    The type of resource, User or App, that modified this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    value String

    The ID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    display String

    The displayName of the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid String

    The OCID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    ref String

    (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    type String

    The type of resource, User or App, that modified this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

    DomainsApiKeyMeta, DomainsApiKeyMetaArgs

    Created string

    The DateTime the Resource was added to the Service Provider

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    Location string

    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ResourceType string

    Name of the resource type of the resource--for example, Users or Groups

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Version string

    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Created string

    The DateTime the Resource was added to the Service Provider

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    Location string

    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ResourceType string

    Name of the resource type of the resource--for example, Users or Groups

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Version string

    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    created String

    The DateTime the Resource was added to the Service Provider

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    location String

    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    resourceType String

    Name of the resource type of the resource--for example, Users or Groups

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    version String

    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    created string

    The DateTime the Resource was added to the Service Provider

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    location string

    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    resourceType string

    Name of the resource type of the resource--for example, Users or Groups

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    version string

    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    created str

    The DateTime the Resource was added to the Service Provider

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    location str

    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    resource_type str

    Name of the resource type of the resource--for example, Users or Groups

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    version str

    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    created String

    The DateTime the Resource was added to the Service Provider

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    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.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    location String

    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    resourceType String

    Name of the resource type of the resource--for example, Users or Groups

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    version String

    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

    DomainsApiKeyTag, DomainsApiKeyTagArgs

    Key string

    Key or name of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Value string

    Value of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Key string

    Key or name of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Value string

    Value of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    key String

    Key or name of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    value String

    Value of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    key string

    Key or name of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    value string

    Value of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    key str

    Key or name of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    value str

    Value of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    key String

    Key or name of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    value String

    Value of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none

    DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser, DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUserArgs

    AllowSelfChange bool

    If true, allows requesting user to update themselves. If false, requesting user can't update themself (default).

    Added In: 2205182039

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: false
    • mutability: writeOnly
    • required: false
    • returned: never
    • type: boolean
    • uniqueness: none
    AllowSelfChange bool

    If true, allows requesting user to update themselves. If false, requesting user can't update themself (default).

    Added In: 2205182039

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: false
    • mutability: writeOnly
    • required: false
    • returned: never
    • type: boolean
    • uniqueness: none
    allowSelfChange Boolean

    If true, allows requesting user to update themselves. If false, requesting user can't update themself (default).

    Added In: 2205182039

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: false
    • mutability: writeOnly
    • required: false
    • returned: never
    • type: boolean
    • uniqueness: none
    allowSelfChange boolean

    If true, allows requesting user to update themselves. If false, requesting user can't update themself (default).

    Added In: 2205182039

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: false
    • mutability: writeOnly
    • required: false
    • returned: never
    • type: boolean
    • uniqueness: none
    allow_self_change bool

    If true, allows requesting user to update themselves. If false, requesting user can't update themself (default).

    Added In: 2205182039

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: false
    • mutability: writeOnly
    • required: false
    • returned: never
    • type: boolean
    • uniqueness: none
    allowSelfChange Boolean

    If true, allows requesting user to update themselves. If false, requesting user can't update themself (default).

    Added In: 2205182039

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: false
    • mutability: writeOnly
    • required: false
    • returned: never
    • type: boolean
    • uniqueness: none

    DomainsApiKeyUser, DomainsApiKeyUserArgs

    Display string

    (Updatable) The user's display name.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Name string

    (Updatable) The username.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Ocid string

    The user's OCID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    Ref string

    (Updatable) The URI that corresponds to the user linked to this credential.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Value string

    The user's ID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Display string

    (Updatable) The user's display name.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Name string

    (Updatable) The username.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Ocid string

    The user's OCID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    Ref string

    (Updatable) The URI that corresponds to the user linked to this credential.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Value string

    The user's ID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    display String

    (Updatable) The user's display name.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    name String

    (Updatable) The username.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid String

    The user's OCID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    ref String

    (Updatable) The URI that corresponds to the user linked to this credential.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    value String

    The user's ID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    display string

    (Updatable) The user's display name.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    name string

    (Updatable) The username.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid string

    The user's OCID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    ref string

    (Updatable) The URI that corresponds to the user linked to this credential.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    value string

    The user's ID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    display str

    (Updatable) The user's display name.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    name str

    (Updatable) The username.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid str

    The user's OCID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    ref str

    (Updatable) The URI that corresponds to the user linked to this credential.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    value str

    The user's ID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    display String

    (Updatable) The user's display name.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    name String

    (Updatable) The username.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ocid String

    The user's OCID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    ref String

    (Updatable) The URI that corresponds to the user linked to this credential.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    value String

    The user's ID.

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: always
    • type: string
    • uniqueness: none

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

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

    $ pulumi import oci:Identity/domainsApiKey:DomainsApiKey test_api_key "idcsEndpoint/{idcsEndpoint}/apiKeys/{apiKeyId}"
    

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi