Oracle Cloud Infrastructure v2.30.0, Apr 14 25

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.Identity.getDomainsApiKey

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testApiKey = oci.Identity.getDomainsApiKey({
    apiKeyId: testApiKeyOciIdentityApiKey.id,
    idcsEndpoint: testDomain.url,
    attributeSets: [],
    attributes: "",
    authorization: apiKeyAuthorization,
    resourceTypeSchemaVersion: apiKeyResourceTypeSchemaVersion,
});

import pulumi
import pulumi_oci as oci

test_api_key = oci.Identity.get_domains_api_key(api_key_id=test_api_key_oci_identity_api_key["id"],
    idcs_endpoint=test_domain["url"],
    attribute_sets=[],
    attributes="",
    authorization=api_key_authorization,
    resource_type_schema_version=api_key_resource_type_schema_version)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.GetDomainsApiKey(ctx, &identity.GetDomainsApiKeyArgs{
			ApiKeyId:                  testApiKeyOciIdentityApiKey.Id,
			IdcsEndpoint:              testDomain.Url,
			AttributeSets:             []interface{}{},
			Attributes:                pulumi.StringRef(""),
			Authorization:             pulumi.StringRef(apiKeyAuthorization),
			ResourceTypeSchemaVersion: pulumi.StringRef(apiKeyResourceTypeSchemaVersion),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testApiKey = Oci.Identity.GetDomainsApiKey.Invoke(new()
    {
        ApiKeyId = testApiKeyOciIdentityApiKey.Id,
        IdcsEndpoint = testDomain.Url,
        AttributeSets = new() { },
        Attributes = "",
        Authorization = apiKeyAuthorization,
        ResourceTypeSchemaVersion = apiKeyResourceTypeSchemaVersion,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.IdentityFunctions;
import com.pulumi.oci.Identity.inputs.GetDomainsApiKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var testApiKey = IdentityFunctions.getDomainsApiKey(GetDomainsApiKeyArgs.builder()
            .apiKeyId(testApiKeyOciIdentityApiKey.id())
            .idcsEndpoint(testDomain.url())
            .attributeSets()
            .attributes("")
            .authorization(apiKeyAuthorization)
            .resourceTypeSchemaVersion(apiKeyResourceTypeSchemaVersion)
            .build());

    }
}

variables:
  testApiKey:
    fn::invoke:
      function: oci:Identity:getDomainsApiKey
      arguments:
        apiKeyId: ${testApiKeyOciIdentityApiKey.id}
        idcsEndpoint: ${testDomain.url}
        attributeSets: []
        attributes: ""
        authorization: ${apiKeyAuthorization}
        resourceTypeSchemaVersion: ${apiKeyResourceTypeSchemaVersion}

Using getDomainsApiKey

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

TypeScript
Python
Go
C#
Java
YAML

function getDomainsApiKey(args: GetDomainsApiKeyArgs, opts?: InvokeOptions): Promise<GetDomainsApiKeyResult>
function getDomainsApiKeyOutput(args: GetDomainsApiKeyOutputArgs, opts?: InvokeOptions): Output<GetDomainsApiKeyResult>

def get_domains_api_key(api_key_id: Optional[str] = None,
                        attribute_sets: Optional[Sequence[str]] = None,
                        attributes: Optional[str] = None,
                        authorization: Optional[str] = None,
                        idcs_endpoint: Optional[str] = None,
                        resource_type_schema_version: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetDomainsApiKeyResult
def get_domains_api_key_output(api_key_id: Optional[pulumi.Input[str]] = None,
                        attribute_sets: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        attributes: Optional[pulumi.Input[str]] = None,
                        authorization: Optional[pulumi.Input[str]] = None,
                        idcs_endpoint: Optional[pulumi.Input[str]] = None,
                        resource_type_schema_version: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetDomainsApiKeyResult]

func GetDomainsApiKey(ctx *Context, args *GetDomainsApiKeyArgs, opts ...InvokeOption) (*GetDomainsApiKeyResult, error)
func GetDomainsApiKeyOutput(ctx *Context, args *GetDomainsApiKeyOutputArgs, opts ...InvokeOption) GetDomainsApiKeyResultOutput

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

public static class GetDomainsApiKey 
{
    public static Task<GetDomainsApiKeyResult> InvokeAsync(GetDomainsApiKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainsApiKeyResult> Invoke(GetDomainsApiKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDomainsApiKeyResult> getDomainsApiKey(GetDomainsApiKeyArgs args, InvokeOptions options)
public static Output<GetDomainsApiKeyResult> getDomainsApiKey(GetDomainsApiKeyArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Identity/getDomainsApiKey:getDomainsApiKey
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiKeyId string: ID of the resource
IdcsEndpoint string: The basic endpoint for the identity domain
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.
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.

ApiKeyId string: ID of the resource
IdcsEndpoint string: The basic endpoint for the identity domain
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.
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.

apiKeyId String: ID of the resource
idcsEndpoint String: The basic endpoint for the identity domain
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.
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.

apiKeyId string: ID of the resource
idcsEndpoint string: The basic endpoint for the identity domain
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.
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.

api_key_id str: ID of the resource
idcs_endpoint str: The basic endpoint for the identity domain
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.
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.

apiKeyId String: ID of the resource
idcsEndpoint String: The basic endpoint for the identity domain
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.
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.

getDomainsApiKey Result

The following output properties are available:

ApiKeyId string
CompartmentOcid string: Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
DeleteInProgress bool: A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
Description string: Description
DomainOcid string: Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
Fingerprint string: Fingerprint
Id string: Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
IdcsCreatedBies List<GetDomainsApiKeyIdcsCreatedBy>: The User or App who created the Resource
IdcsEndpoint string
IdcsLastModifiedBies List<GetDomainsApiKeyIdcsLastModifiedBy>: The User or App who modified the Resource
IdcsLastUpgradedInRelease string: The release number when the resource was upgraded.
IdcsPreventedOperations List<string>: Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Key string: Key or name of the tag.
Metas List<GetDomainsApiKeyMeta>: A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
Ocid string: The user's OCID.
Schemas List<string>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
Tags List<GetDomainsApiKeyTag>: A list of tags on this resource.
TenancyOcid string: Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
UrnietfparamsscimschemasoracleidcsextensionselfChangeUsers List<GetDomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser>: Controls whether a user can update themselves or not via User related APIs
Users List<GetDomainsApiKeyUser>: The user linked to the API key.
AttributeSets List<string>
Attributes string
Authorization string
ResourceTypeSchemaVersion string

ApiKeyId string
CompartmentOcid string: Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
DeleteInProgress bool: A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
Description string: Description
DomainOcid string: Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
Fingerprint string: Fingerprint
Id string: Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
IdcsCreatedBies []GetDomainsApiKeyIdcsCreatedBy: The User or App who created the Resource
IdcsEndpoint string
IdcsLastModifiedBies []GetDomainsApiKeyIdcsLastModifiedBy: The User or App who modified the Resource
IdcsLastUpgradedInRelease string: The release number when the resource was upgraded.
IdcsPreventedOperations []string: Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Key string: Key or name of the tag.
Metas []GetDomainsApiKeyMeta: A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
Ocid string: The user's OCID.
Schemas []string: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
Tags []GetDomainsApiKeyTag: A list of tags on this resource.
TenancyOcid string: Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
UrnietfparamsscimschemasoracleidcsextensionselfChangeUsers []GetDomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser: Controls whether a user can update themselves or not via User related APIs
Users []GetDomainsApiKeyUser: The user linked to the API key.
AttributeSets []string
Attributes string
Authorization string
ResourceTypeSchemaVersion string

apiKeyId String
compartmentOcid String: Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress Boolean: A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
description String: Description
domainOcid String: Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint String: Fingerprint
id String: Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
idcsCreatedBies List<GetDomainsApiKeyIdcsCreatedBy>: The User or App who created the Resource
idcsEndpoint String
idcsLastModifiedBies List<GetDomainsApiKeyIdcsLastModifiedBy>: The User or App who modified the Resource
idcsLastUpgradedInRelease String: The release number when the resource was upgraded.
idcsPreventedOperations List<String>: Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
key String: Key or name of the tag.
metas List<GetDomainsApiKeyMeta>: A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
ocid String: The user's OCID.
schemas List<String>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
tags List<GetDomainsApiKeyTag>: A list of tags on this resource.
tenancyOcid String: Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
urnietfparamsscimschemasoracleidcsextensionselfChangeUsers List<GetDomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser>: Controls whether a user can update themselves or not via User related APIs
users List<GetDomainsApiKeyUser>: The user linked to the API key.
attributeSets List<String>
attributes String
authorization String
resourceTypeSchemaVersion String

apiKeyId string
compartmentOcid string: Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress boolean: A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
description string: Description
domainOcid string: Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint string: Fingerprint
id string: Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
idcsCreatedBies GetDomainsApiKeyIdcsCreatedBy[]: The User or App who created the Resource
idcsEndpoint string
idcsLastModifiedBies GetDomainsApiKeyIdcsLastModifiedBy[]: The User or App who modified the Resource
idcsLastUpgradedInRelease string: The release number when the resource was upgraded.
idcsPreventedOperations string[]: Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
key string: Key or name of the tag.
metas GetDomainsApiKeyMeta[]: A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
ocid string: The user's OCID.
schemas string[]: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
tags GetDomainsApiKeyTag[]: A list of tags on this resource.
tenancyOcid string: Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
urnietfparamsscimschemasoracleidcsextensionselfChangeUsers GetDomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser[]: Controls whether a user can update themselves or not via User related APIs
users GetDomainsApiKeyUser[]: The user linked to the API key.
attributeSets string[]
attributes string
authorization string
resourceTypeSchemaVersion string

api_key_id str
compartment_ocid str: Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
delete_in_progress bool: A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
description str: Description
domain_ocid str: Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint str: Fingerprint
id str: Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
idcs_created_bies Sequence[identity.GetDomainsApiKeyIdcsCreatedBy]: The User or App who created the Resource
idcs_endpoint str
idcs_last_modified_bies Sequence[identity.GetDomainsApiKeyIdcsLastModifiedBy]: The User or App who modified the Resource
idcs_last_upgraded_in_release str: The release number when the resource was upgraded.
idcs_prevented_operations Sequence[str]: Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
key str: Key or name of the tag.
metas Sequence[identity.GetDomainsApiKeyMeta]: A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
ocid str: The user's OCID.
schemas Sequence[str]: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
tags Sequence[identity.GetDomainsApiKeyTag]: A list of tags on this resource.
tenancy_ocid str: Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
urnietfparamsscimschemasoracleidcsextensionself_change_users Sequence[identity.GetDomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser]: Controls whether a user can update themselves or not via User related APIs
users Sequence[identity.GetDomainsApiKeyUser]: The user linked to the API key.
attribute_sets Sequence[str]
attributes str
authorization str
resource_type_schema_version str

apiKeyId String
compartmentOcid String: Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives.
deleteInProgress Boolean: A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
description String: Description
domainOcid String: Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives.
fingerprint String: Fingerprint
id String: Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
idcsCreatedBies List<Property Map>: The User or App who created the Resource
idcsEndpoint String
idcsLastModifiedBies List<Property Map>: The User or App who modified the Resource
idcsLastUpgradedInRelease String: The release number when the resource was upgraded.
idcsPreventedOperations List<String>: Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
key String: Key or name of the tag.
metas List<Property Map>: A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
ocid String: The user's OCID.
schemas List<String>: REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard "enterprise" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
tags List<Property Map>: A list of tags on this resource.
tenancyOcid String: Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives.
urnietfparamsscimschemasoracleidcsextensionselfChangeUsers List<Property Map>: Controls whether a user can update themselves or not via User related APIs
users List<Property Map>: The user linked to the API key.
attributeSets List<String>
attributes String
authorization String
resourceTypeSchemaVersion String

Supporting Types

GetDomainsApiKeyIdcsCreatedBy

Display string: The user's display name.
Ocid string: The user's OCID.
Ref string: The URI that corresponds to the user linked to this credential.
Type string: The type of resource, User or App, that modified this Resource
Value string: The user's ID.

Display string: The user's display name.
Ocid string: The user's OCID.
Ref string: The URI that corresponds to the user linked to this credential.
Type string: The type of resource, User or App, that modified this Resource
Value string: The user's ID.

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

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

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

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

GetDomainsApiKeyIdcsLastModifiedBy

Display string: The user's display name.
Ocid string: The user's OCID.
Ref string: The URI that corresponds to the user linked to this credential.
Type string: The type of resource, User or App, that modified this Resource
Value string: The user's ID.

Display string: The user's display name.
Ocid string: The user's OCID.
Ref string: The URI that corresponds to the user linked to this credential.
Type string: The type of resource, User or App, that modified this Resource
Value string: The user's ID.

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

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

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

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

GetDomainsApiKeyMeta

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

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

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

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

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

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

GetDomainsApiKeyTag

Key string: Key or name of the tag.
Value string: The user's ID.

Key string: Key or name of the tag.
Value string: The user's ID.

key String: Key or name of the tag.
value String: The user's ID.

key string: Key or name of the tag.
value string: The user's ID.

key str: Key or name of the tag.
value str: The user's ID.

key String: Key or name of the tag.
value String: The user's ID.

GetDomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser

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

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

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

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

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

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

GetDomainsApiKeyUser

Display string: The user's display name.
Name string: The username.
Ocid string: The user's OCID.
Ref string: The URI that corresponds to the user linked to this credential.
Value string: The user's ID.

Display string: The user's display name.
Name string: The username.
Ocid string: The user's OCID.
Ref string: The URI that corresponds to the user linked to this credential.
Value string: The user's ID.

display String: The user's display name.
name String: The username.
ocid String: The user's OCID.
ref String: The URI that corresponds to the user linked to this credential.
value String: The user's ID.

display string: The user's display name.
name string: The username.
ocid string: The user's OCID.
ref string: The URI that corresponds to the user linked to this credential.
value string: The user's ID.

display str: The user's display name.
name str: The username.
ocid str: The user's OCID.
ref str: The URI that corresponds to the user linked to this credential.
value str: The user's ID.

display String: The user's display name.
name String: The username.
ocid String: The user's OCID.
ref String: The URI that corresponds to the user linked to this credential.
value String: The user's ID.

Package Details

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

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-oci

oci.Identity.getDomainsApiKey

On this page

On this page

Example Usage

Using getDomainsApiKey

getDomainsApiKey Result

Supporting Types

GetDomainsApiKeyIdcsCreatedBy

GetDomainsApiKeyIdcsLastModifiedBy

GetDomainsApiKeyMeta

GetDomainsApiKeyTag

GetDomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser

GetDomainsApiKeyUser

Package Details

On this page

On this page