Data Source: oci_identity_domains_oauth2client_credentials

This data source provides the list of O Auth2 Client Credentials in Oracle Cloud Infrastructure Identity Domains service.

Search for a user’s OAuth2 client credentials.

Example Usage

data "oci_identity_domains_oauth2client_credentials" "test_oauth2client_credentials" {
	#Required
	idcs_endpoint = data.oci_identity_domain.test_domain.url

	#Optional
	oauth2client_credential_count = var.oauth2client_credential_oauth2client_credential_count
	oauth2client_credential_filter = var.oauth2client_credential_oauth2client_credential_filter
	attribute_sets = []
	attributes = ""
	authorization = var.oauth2client_credential_authorization
	resource_type_schema_version = var.oauth2client_credential_resource_type_schema_version
	start_index = var.oauth2client_credential_start_index
}

Argument Reference

The following arguments are supported:

• oauth2client_credential_count - (Optional) OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4).
• oauth2client_credential_filter - (Optional) OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.
• attribute_sets - (Optional) 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 - (Optional) 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 - (Optional) The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
• idcs_endpoint - (Required) The basic endpoint for the identity domain
• resource_type_schema_version - (Optional) 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.
• start_index - (Optional) OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on.

Attributes Reference

The following attributes are exported:

• oauth2client_credentials - The list of oauth2client_credentials.

OAuth2ClientCredential Reference

The following attributes are exported:

• compartment_ocid - 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 - 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 - Description

  Added In: 2101262133

  SCIM++ Properties:

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

• domain_ocid - 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

• expires_on - When the user’s credentials expire.

  Added In: 2109090424

  SCIM++ Properties:

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

• id - 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.

  SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: always
  • type: string
  • uniqueness: global

• idcs_created_by - The User or App who created the Resource

  SCIM++ Properties:

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: true

  • returned: default

  • type: complex

  • display - 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 - 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 - 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 - 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 - 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

• idcs_last_modified_by - The User or App who modified the Resource

  SCIM++ Properties:

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: complex

  • display - 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 - 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 - 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 - 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 - 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

• idcs_last_upgraded_in_release - 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 - 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

• is_reset_secret - Specifies whether the secret must be reset.

  Added In: 2109090424

  SCIM++ Properties:

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

• meta - 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

  • created - 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 - 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 - 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 - 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 - 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

• name - Name

  SCIM++ Properties:

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

• ocid - 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

• schemas - 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

• scopes - Scopes

  SCIM++ Properties:

  • caseExact: false

  • idcsCompositeKey: [audience, scope]

  • type: complex

  • mutability: readWrite

  • multiValued: true

  • required: true

  • returned: default

  • audience - Audience

    SCIM++ Properties:

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

  • scope - Scope

    SCIM++ Properties:

    • caseExact: false
    • idcsScimCompliant: false
    • type: string
    • mutability: readWrite
    • multiValued: false
    • required: true
    • returned: default

• secret - Secret

  SCIM++ Properties:

  • caseExact: false
  • type: string
  • mutability: readOnly
  • required: false
  • returned: default
  • idcsScimCompliant: false
  • idcsSensitive: hash_sc

• status - The user’s credential status.

  Added In: 2109090424

  SCIM++ Properties:

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

• tags - 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

  • key - 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 - Value of the tag.

    SCIM++ Properties:

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

• tenancy_ocid - 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 - Controls whether a user can update themselves or not via User related APIs

  • allow_self_change - 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

• user - The user linked to the OAuth2 client credential.

  SCIM++ Properties:

  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: complex

  • uniqueness: none

  • display - The user’s display name.

    SCIM++ Properties:

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

  • name - The username.

    SCIM++ Properties:

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

  • ocid - The user’s OCID.

    SCIM++ Properties:

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

  • ref - 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 - The user’s ID.

    SCIM++ Properties:

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