openapi: 3.2.0
info:
  description: 'Use the Identity Domains API to manage resources within an identity domain, for example, users, dynamic resource groups, groups, and identity providers. For information about managing resources within identity domains, see [Identity and Access Management (with identity domains)](https://docs.oracle.com/iaas/Content/Identity/home.htm).

    Use this pattern to construct endpoints for identity domains: `https://<domainURL>/admin/v1/`. See [Finding an Identity Domain URL](https://docs.oracle.com/en-us/iaas/Content/Identity/api-getstarted/locate-identity-domain-url.htm) to locate the domain URL you need.

    Use the table of contents and search tool to explore the Identity Domains API.'
  title: Identity Domains API
  version: v1
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/ba3bfd439325eb31153a9c7a2fe1b54257a79082f61ef86d9f9de998bfde084c.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Identity Domains API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/ba3bfd439325eb31153a9c7a2fe1b54257a79082f61ef86d9f9de998bfde084c.yaml
    what: the harvested document for Identity Domains API
tags:
- name: identityDomains
paths:
  /admin/v1/AccountMgmtInfos:
    get:
      description: Search Account Mgmt Info
      operationId: ListAccountMgmtInfos
      parameters:
      - description: 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.
        in: query
        name: filter
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3).
        in: query
        name: sortBy
        required: false
        schema:
          type: string
          default: id
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - description: 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.
        in: query
        name: startIndex
        required: false
        schema:
          type: integer
          default: 1
      - description: 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).
        in: query
        name: count
        required: false
        schema:
          type: integer
          default: 50
          maximum: 1000
      - description: 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.
        in: query
        name: attributes
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - $ref: '#/components/parameters/AttributeSetsQueryParam'
      - description: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
        in: header
        name: authorization
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: header
        name: resource_type_schema_version
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
        in: header
        name: opc-retry-token
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        '200':
          description: The request was successful.
          headers:
            opc-next-page:
              description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
              schema:
                type: string
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountMgmtInfos'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/AccountMgmtInfos'
        '400':
          description: Bad or invalid request
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The supplied credentials, if any, are not sufficient to access the resource.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: We couldn't return the representation due to an internal server error.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - identityDomains
  /admin/v1/AccountMgmtInfos/.search:
    post:
      description: Search Account Mgmt Info Using POST
      operationId: SearchAccountMgmtInfos
      parameters:
      - description: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
        in: header
        name: authorization
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: header
        name: resource_type_schema_version
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
        in: header
        name: opc-retry-token
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        '200':
          description: The request was successful.
          headers:
            opc-next-page:
              description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
              schema:
                type: string
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountMgmtInfos'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/AccountMgmtInfos'
        '400':
          description: Bad or invalid request
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The supplied credentials, if any, are not sufficient to access the resource.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The requested resource could not be found.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: We couldn't return the representation due to an internal server error.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - identityDomains
      requestBody:
        content:
          application/scim+json:
            schema:
              $ref: '#/components/schemas/AccountMgmtInfoSearchRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/AccountMgmtInfoSearchRequest'
        description: Parameters for searching AccountMgmtInfos
  /admin/v1/AccountMgmtInfos/{accountMgmtInfoId}:
    get:
      description: Get Account Mgmt Info
      operationId: GetAccountMgmtInfo
      parameters:
      - description: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
        in: header
        name: authorization
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: header
        name: resource_type_schema_version
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: query
        name: attributes
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - $ref: '#/components/parameters/AttributeSetsQueryParam'
      - description: ID of the resource
        in: path
        name: accountMgmtInfoId
        required: true
        schema:
          type: string
      - description: A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
        in: header
        name: opc-retry-token
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request was successful.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountMgmtInfo'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/AccountMgmtInfo'
        '400':
          description: Bad or invalid request
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The supplied credentials, if any, are not sufficient to access the resource.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The requested resource was not found.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: We couldn't return the representation due to an internal server error.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - identityDomains
  /admin/v1/AccountRecoverySettings:
    get:
      description: Search for account recovery settings.
      operationId: ListAccountRecoverySettings
      parameters:
      - description: 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.
        in: query
        name: attributes
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - $ref: '#/components/parameters/AttributeSetsQueryParam'
      - description: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
        in: header
        name: authorization
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: header
        name: resource_type_schema_version
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
        in: header
        name: opc-retry-token
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        '200':
          description: The request was successful.
          headers:
            opc-next-page:
              description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
              schema:
                type: string
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRecoverySettings'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/AccountRecoverySettings'
        '400':
          description: Bad or invalid request
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The supplied credentials, if any, are not sufficient to access the resource.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: We couldn't return the representation due to an internal server error.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - identityDomains
  /admin/v1/AccountRecoverySettings/{accountRecoverySettingId}:
    get:
      description: Get an account recovery setting.
      operationId: GetAccountRecoverySetting
      parameters:
      - description: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
        in: header
        name: authorization
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: header
        name: resource_type_schema_version
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: query
        name: attributes
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - $ref: '#/components/parameters/AttributeSetsQueryParam'
      - description: ID of the resource
        in: path
        name: accountRecoverySettingId
        required: true
        schema:
          type: string
      - description: A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
        in: header
        name: opc-retry-token
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request was successful.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRecoverySetting'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/AccountRecoverySetting'
        '400':
          description: Bad or invalid request
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The supplied credentials, if any, are not sufficient to access the resource.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The requested resource was not found.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: We couldn't return the representation due to an internal server error.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - identityDomains
    patch:
      description: Update an account recovery setting.
      operationId: PatchAccountRecoverySetting
      parameters:
      - description: The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
        in: header
        name: authorization
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: header
        name: resource_type_schema_version
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - description: 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.
        in: query
        name: attributes
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - $ref: '#/components/parameters/AttributeSetsQueryParam'
      - description: ID of the resource
        in: path
        name: accountRecoverySettingId
        required: true
        schema:
          type: string
      - description: Used to make the request conditional on an ETag
        in: header
        name: if-match
        required: false
        schema:
          type: string
      - description: A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
        in: header
        name: opc-retry-token
        required: false
        schema:
          type: string
      responses:
        '200':
          descri

# --- truncated at 32 KB (3595 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-identitydomains-api-openapi.yml