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:///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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the AccountRecoverySettings with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace an account recovery setting. operationId: PutAccountRecoverySetting 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/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 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' '412': description: Preconditions in clients headers are not met by the server 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/AccountRecoverySetting' application/json: schema: $ref: '#/components/schemas/AccountRecoverySetting' description: "Replace the current instance of AccountRecoverySettings with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/ApiKeys: get: description: Search API keys. operationId: ListApiKeys 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/ApiKeys' application/scim+json: schema: $ref: '#/components/schemas/ApiKeys' '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 post: description: Create a user's API key. operationId: CreateApiKey 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/ApiKey' application/scim+json: schema: $ref: '#/components/schemas/ApiKey' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/ApiKey' application/json: schema: $ref: '#/components/schemas/ApiKey' description: "ApiKey schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/ApiKeys/.search: post: description: Search for API keys using POST. operationId: SearchApiKeys 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/ApiKeys' application/scim+json: schema: $ref: '#/components/schemas/ApiKeys' '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/ApiKeySearchRequest' application/json: schema: $ref: '#/components/schemas/ApiKeySearchRequest' description: Parameters for searching ApiKeys /admin/v1/ApiKeys/{apiKeyId}: delete: description: Delete a user's API key. operationId: DeleteApiKey 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: apiKeyId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/ApiKey' get: description: Get a user's API key. operationId: GetApiKey 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: apiKeyId 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/ApiKey' application/scim+json: schema: $ref: '#/components/schemas/ApiKey' '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 a user's API key. operationId: PatchApiKey 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: apiKeyId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/ApiKey' application/scim+json: schema: $ref: '#/components/schemas/ApiKey' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the ApiKey with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/AppRoles: get: description: Search AppRoles operationId: ListAppRoles 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/AppRoles' application/scim+json: schema: $ref: '#/components/schemas/AppRoles' '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 post: description: Create an AppRole operationId: CreateAppRole 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/AppRole' application/scim+json: schema: $ref: '#/components/schemas/AppRole' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/AppRole' application/json: schema: $ref: '#/components/schemas/AppRole' description: "AppRole schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/AppRoles/.search: post: description: Search AppRoles Using POST operationId: SearchAppRoles 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/AppRoles' application/scim+json: schema: $ref: '#/components/schemas/AppRoles' '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/AppRoleSearchRequest' application/json: schema: $ref: '#/components/schemas/AppRoleSearchRequest' description: Parameters for searching AppRoles /admin/v1/AppRoles/{appRoleId}: delete: description: Delete an AppRole operationId: DeleteAppRole 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: appRoleId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/AppRole' get: description: Get an AppRole operationId: GetAppRole 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: appRoleId 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/AppRole' application/scim+json: schema: $ref: '#/components/schemas/AppRole' '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 AppRole operationId: PatchAppRole 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: appRoleId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/AppRole' application/scim+json: schema: $ref: '#/components/schemas/AppRole' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the AppRole with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/AppStatusChanger/{appStatusChangerId}: put: description: Activate/Deactivate an App operationId: PutAppStatusChanger 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: appStatusChangerId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/AppStatusChanger' application/scim+json: schema: $ref: '#/components/schemas/AppStatusChanger' '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' '412': description: Preconditions in clients headers are not met by the server 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/AppStatusChanger' application/json: schema: $ref: '#/components/schemas/AppStatusChanger' description: "Replace the current instance of AppStatusChanger with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/ApprovalWorkflowAssignments: get: description: Search Approval Workflow Assignments operationId: ListApprovalWorkflowAssignments 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/ApprovalWorkflowAssignments' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowAssignments' '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 post: description: Create Approval Workflow Assignment operationId: CreateApprovalWorkflowAssignment 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/ApprovalWorkflowAssignment' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowAssignment' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowAssignment' application/json: schema: $ref: '#/components/schemas/ApprovalWorkflowAssignment' description: "ApprovalWorkflowAssignment schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/ApprovalWorkflowAssignments/{approvalWorkflowAssignmentId}: delete: description: Delete Approval Workflow Assignment operationId: DeleteApprovalWorkflowAssignment 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: approvalWorkflowAssignmentId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/ApprovalWorkflowAssignment' get: description: Get an Approval Workflow Assignment operationId: GetApprovalWorkflowAssignment 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: approvalWorkflowAssignmentId 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/ApprovalWorkflowAssignment' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowAssignment' '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/ApprovalWorkflowSteps: get: description: Search ApprovalWorkflowStep operationId: ListApprovalWorkflowSteps 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/ApprovalWorkflowSteps' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowSteps' '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 post: description: Create ApprovalWorkflowStep operationId: CreateApprovalWorkflowStep 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/ApprovalWorkflowStep' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowStep' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowStep' application/json: schema: $ref: '#/components/schemas/ApprovalWorkflowStep' description: "ApprovalWorkflowStep schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/ApprovalWorkflowSteps/{approvalWorkflowStepId}: delete: description: Delete ApprovalWorkflowStep operationId: DeleteApprovalWorkflowStep 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: approvalWorkflowStepId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/ApprovalWorkflowStep' get: description: Get ApprovalWorkflowStep operationId: GetApprovalWorkflowStep 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: approvalWorkflowStepId 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/ApprovalWorkflowStep' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowStep' '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 ApprovalWorkflowStep operationId: PatchApprovalWorkflowStep 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: approvalWorkflowStepId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/ApprovalWorkflowStep' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflowStep' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the ApprovalWorkflowStep with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/ApprovalWorkflows: get: description: Search ApprovalWorkflow operationId: ListApprovalWorkflows 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/ApprovalWorkflows' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflows' '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 post: description: Create ApprovalWorkflow operationId: CreateApprovalWorkflow 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/ApprovalWorkflow' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflow' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflow' application/json: schema: $ref: '#/components/schemas/ApprovalWorkflow' description: "ApprovalWorkflow schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/ApprovalWorkflows/{approvalWorkflowId}: delete: description: Delete ApprovalWorkflow operationId: DeleteApprovalWorkflow 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: approvalWorkflowId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/ApprovalWorkflow' get: description: Get ApprovalWorkflow operationId: GetApprovalWorkflow 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: approvalWorkflowId 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/ApprovalWorkflow' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflow' '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 ApprovalWorkflow operationId: PatchApprovalWorkflow 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: approvalWorkflowId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/ApprovalWorkflow' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflow' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the ApprovalWorkflow with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace ApprovalWorkflow operationId: PutApprovalWorkflow 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: approvalWorkflowId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/ApprovalWorkflow' application/scim+json: schema: $ref: '#/components/schemas/ApprovalWorkflow' '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' '412': description: Preconditions in clients headers are not met by the server 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/ApprovalWorkflow' application/json: schema: $ref: '#/components/schemas/ApprovalWorkflow' description: "Replace the current instance of ApprovalWorkflow with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Apps: get: description: Search Apps operationId: ListApps 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/Apps' application/scim+json: schema: $ref: '#/components/schemas/Apps' '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 post: description: Create an App operationId: CreateApp 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/App' application/scim+json: schema: $ref: '#/components/schemas/App' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/App' application/json: schema: $ref: '#/components/schemas/App' description: "App schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Apps/.search: post: description: Search Apps Using POST operationId: SearchApps 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/Apps' application/scim+json: schema: $ref: '#/components/schemas/Apps' '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/AppSearchRequest' application/json: schema: $ref: '#/components/schemas/AppSearchRequest' description: Parameters for searching Apps /admin/v1/Apps/{appId}: delete: description: Delete an App operationId: DeleteApp 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: appId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/App' get: description: Get an App operationId: GetApp 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: appId 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/App' application/scim+json: schema: $ref: '#/components/schemas/App' '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 App operationId: PatchApp 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: appId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/App' application/scim+json: schema: $ref: '#/components/schemas/App' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the App with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace an App operationId: PutApp 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: appId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/App' application/scim+json: schema: $ref: '#/components/schemas/App' '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' '412': description: Preconditions in clients headers are not met by the server 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/App' application/json: schema: $ref: '#/components/schemas/App' description: "Replace the current instance of App with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/AuthTokens: get: description: Search for Auth tokens. operationId: ListAuthTokens 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/AuthTokens' application/scim+json: schema: $ref: '#/components/schemas/AuthTokens' '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 post: description: Create a user's Auth token. operationId: CreateAuthToken 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/AuthToken' application/scim+json: schema: $ref: '#/components/schemas/AuthToken' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/AuthToken' application/json: schema: $ref: '#/components/schemas/AuthToken' description: "AuthToken schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/AuthTokens/.search: post: description: Search for Auth tokens using POST. operationId: SearchAuthTokens 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/AuthTokens' application/scim+json: schema: $ref: '#/components/schemas/AuthTokens' '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/AuthTokenSearchRequest' application/json: schema: $ref: '#/components/schemas/AuthTokenSearchRequest' description: Parameters for searching AuthTokens /admin/v1/AuthTokens/{authTokenId}: delete: description: Delete a user's Auth token. operationId: DeleteAuthToken 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: authTokenId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/AuthToken' get: description: Get a user's Auth token. operationId: GetAuthToken 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: authTokenId 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/AuthToken' application/scim+json: schema: $ref: '#/components/schemas/AuthToken' '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 a user's Auth token. operationId: PatchAuthToken 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: authTokenId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/AuthToken' application/scim+json: schema: $ref: '#/components/schemas/AuthToken' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the AuthToken with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/AuthenticationFactorSettings: get: description: Search Authentication Factor Settings operationId: ListAuthenticationFactorSettings 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/AuthenticationFactorSettings' application/scim+json: schema: $ref: '#/components/schemas/AuthenticationFactorSettings' '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/AuthenticationFactorSettings/.search: post: description: Search Authentication Factor Settings Using POST operationId: SearchAuthenticationFactorSettings 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/AuthenticationFactorSettings' application/scim+json: schema: $ref: '#/components/schemas/AuthenticationFactorSettings' '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/AuthenticationFactorSettingsSearchRequest' application/json: schema: $ref: '#/components/schemas/AuthenticationFactorSettingsSearchRequest' description: Parameters for searching AuthenticationFactorSettings /admin/v1/AuthenticationFactorSettings/{authenticationFactorSettingId}: get: description: Get Authentication Factor Settings operationId: GetAuthenticationFactorSetting 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: authenticationFactorSettingId 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/AuthenticationFactorSetting' application/scim+json: schema: $ref: '#/components/schemas/AuthenticationFactorSetting' '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 put: description: Replace Authentication Factor Settings operationId: PutAuthenticationFactorSetting 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: authenticationFactorSettingId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/AuthenticationFactorSetting' application/scim+json: schema: $ref: '#/components/schemas/AuthenticationFactorSetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/AuthenticationFactorSetting' application/json: schema: $ref: '#/components/schemas/AuthenticationFactorSetting' description: "Replace the current instance of AuthenticationFactorSettings with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/AuthenticationFactorsRemover: post: description: Remove All Authentication Factor Channels for a User operationId: CreateAuthenticationFactorsRemover 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/AuthenticationFactorsRemover' application/scim+json: schema: $ref: '#/components/schemas/AuthenticationFactorsRemover' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/AuthenticationFactorsRemover' application/json: schema: $ref: '#/components/schemas/AuthenticationFactorsRemover' description: "AuthenticationFactorsRemover schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/BrandingSettings: get: description: Search Branding Settings operationId: ListBrandingSettings 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/BrandingSettings' application/scim+json: schema: $ref: '#/components/schemas/BrandingSettings' '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/BrandingSettings/{brandingSettingId}: get: description: Get Branding Settings operationId: GetBrandingSetting 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: brandingSettingId 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/BrandingSetting' application/scim+json: schema: $ref: '#/components/schemas/BrandingSetting' '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/CloudGateMappings: get: description: Search Cloud Gate mappings operationId: ListCloudGateMappings 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/CloudGateMappings' application/scim+json: schema: $ref: '#/components/schemas/CloudGateMappings' '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 post: description: Create a Cloud Gate mapping operationId: CreateCloudGateMapping 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGateMapping' application/scim+json: schema: $ref: '#/components/schemas/CloudGateMapping' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/CloudGateMapping' application/json: schema: $ref: '#/components/schemas/CloudGateMapping' description: "CloudGateMapping schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/CloudGateMappings/.search: post: description: Search Cloud Gate mappings Using POST operationId: SearchCloudGateMappings 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/CloudGateMappings' application/scim+json: schema: $ref: '#/components/schemas/CloudGateMappings' '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/CloudGateMappingSearchRequest' application/json: schema: $ref: '#/components/schemas/CloudGateMappingSearchRequest' description: Parameters for searching CloudGateMappings /admin/v1/CloudGateMappings/{cloudGateMappingId}: delete: description: Delete a Cloud Gate mapping operationId: DeleteCloudGateMapping 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: cloudGateMappingId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/CloudGateMapping' get: description: Get a Cloud Gate mapping operationId: GetCloudGateMapping 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: cloudGateMappingId 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/CloudGateMapping' application/scim+json: schema: $ref: '#/components/schemas/CloudGateMapping' '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 a Cloud Gate mapping operationId: PatchCloudGateMapping 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: cloudGateMappingId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGateMapping' application/scim+json: schema: $ref: '#/components/schemas/CloudGateMapping' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the CloudGateMapping with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Cloud Gate mapping operationId: PutCloudGateMapping 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: cloudGateMappingId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGateMapping' application/scim+json: schema: $ref: '#/components/schemas/CloudGateMapping' '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' '412': description: Preconditions in clients headers are not met by the server 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/CloudGateMapping' application/json: schema: $ref: '#/components/schemas/CloudGateMapping' description: "Replace the current instance of CloudGateMapping with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/CloudGateServers: get: description: Search Cloud Gate servers operationId: ListCloudGateServers 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/CloudGateServers' application/scim+json: schema: $ref: '#/components/schemas/CloudGateServers' '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 post: description: Create a Cloud Gate server operationId: CreateCloudGateServer 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGateServer' application/scim+json: schema: $ref: '#/components/schemas/CloudGateServer' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/CloudGateServer' application/json: schema: $ref: '#/components/schemas/CloudGateServer' description: "CloudGateServer schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/CloudGateServers/.search: post: description: Search Cloud Gate servers Using POST operationId: SearchCloudGateServers 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/CloudGateServers' application/scim+json: schema: $ref: '#/components/schemas/CloudGateServers' '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/CloudGateServerSearchRequest' application/json: schema: $ref: '#/components/schemas/CloudGateServerSearchRequest' description: Parameters for searching CloudGateServers /admin/v1/CloudGateServers/{cloudGateServerId}: delete: description: Delete a Cloud Gate server operationId: DeleteCloudGateServer 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: cloudGateServerId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/CloudGateServer' get: description: Get a Cloud Gate server operationId: GetCloudGateServer 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: cloudGateServerId 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/CloudGateServer' application/scim+json: schema: $ref: '#/components/schemas/CloudGateServer' '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 a Cloud Gate server operationId: PatchCloudGateServer 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: cloudGateServerId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGateServer' application/scim+json: schema: $ref: '#/components/schemas/CloudGateServer' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the CloudGateServer with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Cloud Gate server operationId: PutCloudGateServer 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: cloudGateServerId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGateServer' application/scim+json: schema: $ref: '#/components/schemas/CloudGateServer' '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' '412': description: Preconditions in clients headers are not met by the server 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/CloudGateServer' application/json: schema: $ref: '#/components/schemas/CloudGateServer' description: "Replace the current instance of CloudGateServer with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/CloudGates: get: description: Search Cloud Gates operationId: ListCloudGates 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/CloudGates' application/scim+json: schema: $ref: '#/components/schemas/CloudGates' '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 post: description: Create a Cloud Gate operationId: CreateCloudGate 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGate' application/scim+json: schema: $ref: '#/components/schemas/CloudGate' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/CloudGate' application/json: schema: $ref: '#/components/schemas/CloudGate' description: "CloudGate schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/CloudGates/.search: post: description: Search Cloud Gates Using POST operationId: SearchCloudGates 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/CloudGates' application/scim+json: schema: $ref: '#/components/schemas/CloudGates' '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/CloudGateSearchRequest' application/json: schema: $ref: '#/components/schemas/CloudGateSearchRequest' description: Parameters for searching CloudGates /admin/v1/CloudGates/{cloudGateId}: delete: description: Delete a Cloud Gate operationId: DeleteCloudGate 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: cloudGateId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/CloudGate' get: description: Get a Cloud Gate operationId: GetCloudGate 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: cloudGateId 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/CloudGate' application/scim+json: schema: $ref: '#/components/schemas/CloudGate' '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 a Cloud Gate operationId: PatchCloudGate 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: cloudGateId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGate' application/scim+json: schema: $ref: '#/components/schemas/CloudGate' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the CloudGate with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Cloud Gate operationId: PutCloudGate 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: cloudGateId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CloudGate' application/scim+json: schema: $ref: '#/components/schemas/CloudGate' '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' '412': description: Preconditions in clients headers are not met by the server 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/CloudGate' application/json: schema: $ref: '#/components/schemas/CloudGate' description: "Replace the current instance of CloudGate with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Conditions: get: description: Search conditions. operationId: ListConditions 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/Conditions' application/scim+json: schema: $ref: '#/components/schemas/Conditions' '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 x-related-resource: '#/definitions/Condition' post: description: Create a condition operationId: CreateCondition 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Condition' application/scim+json: schema: $ref: '#/components/schemas/Condition' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/Condition' application/json: schema: $ref: '#/components/schemas/Condition' description: "Condition schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Conditions/.search: post: description: Search Conditions Using POST. operationId: SearchConditions 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/Conditions' application/scim+json: schema: $ref: '#/components/schemas/Conditions' '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 x-related-resource: '#/definitions/Condition' requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/ConditionSearchRequest' application/json: schema: $ref: '#/components/schemas/ConditionSearchRequest' description: Parameters for searching Conditions /admin/v1/Conditions/{conditionId}: delete: description: Delete a condition. operationId: DeleteCondition 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: conditionId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/Condition' get: description: Get a condition. operationId: GetCondition 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: conditionId 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/Condition' application/scim+json: schema: $ref: '#/components/schemas/Condition' '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 a condition. operationId: PatchCondition 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: conditionId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Condition' application/scim+json: schema: $ref: '#/components/schemas/Condition' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the Condition with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a condition. operationId: PutCondition 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: conditionId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Condition' application/scim+json: schema: $ref: '#/components/schemas/Condition' '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' '412': description: Preconditions in clients headers are not met by the server 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/Condition' application/json: schema: $ref: '#/components/schemas/Condition' description: "Replace the current instance of Condition with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/CustomerSecretKeys: get: description: Search for a user's customer secret keys. operationId: ListCustomerSecretKeys 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/CustomerSecretKeys' application/scim+json: schema: $ref: '#/components/schemas/CustomerSecretKeys' '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 post: description: Create a user's customer secret key. operationId: CreateCustomerSecretKey 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CustomerSecretKey' application/scim+json: schema: $ref: '#/components/schemas/CustomerSecretKey' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/CustomerSecretKey' application/json: schema: $ref: '#/components/schemas/CustomerSecretKey' description: "CustomerSecretKey schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/CustomerSecretKeys/.search: post: description: Search for customer secret keys using POST. operationId: SearchCustomerSecretKeys 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/CustomerSecretKeys' application/scim+json: schema: $ref: '#/components/schemas/CustomerSecretKeys' '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/CustomerSecretKeySearchRequest' application/json: schema: $ref: '#/components/schemas/CustomerSecretKeySearchRequest' description: Parameters for searching CustomerSecretKeys /admin/v1/CustomerSecretKeys/{customerSecretKeyId}: delete: description: Delete a user's customer secret key. operationId: DeleteCustomerSecretKey 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: customerSecretKeyId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/CustomerSecretKey' get: description: Get a user's customer secret key. operationId: GetCustomerSecretKey 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: customerSecretKeyId 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/CustomerSecretKey' application/scim+json: schema: $ref: '#/components/schemas/CustomerSecretKey' '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 a user's customer secret key. operationId: PatchCustomerSecretKey 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: customerSecretKeyId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/CustomerSecretKey' application/scim+json: schema: $ref: '#/components/schemas/CustomerSecretKey' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the CustomerSecretKey with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/DynamicResourceGroups: get: description: Search for Dynamic Resource Groups. operationId: ListDynamicResourceGroups 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/DynamicResourceGroups' application/scim+json: schema: $ref: '#/components/schemas/DynamicResourceGroups' '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 post: description: Create a Dynamic Resource Group. operationId: CreateDynamicResourceGroup 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/DynamicResourceGroup' application/scim+json: schema: $ref: '#/components/schemas/DynamicResourceGroup' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/DynamicResourceGroup' application/json: schema: $ref: '#/components/schemas/DynamicResourceGroup' description: "DynamicResourceGroup schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/DynamicResourceGroups/.search: post: description: Search for Dynamic Resource Groups using POST. operationId: SearchDynamicResourceGroups 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/DynamicResourceGroups' application/scim+json: schema: $ref: '#/components/schemas/DynamicResourceGroups' '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/DynamicResourceGroupSearchRequest' application/json: schema: $ref: '#/components/schemas/DynamicResourceGroupSearchRequest' description: Parameters for searching DynamicResourceGroups /admin/v1/DynamicResourceGroups/{dynamicResourceGroupId}: delete: description: Delete a Dynamic Resource Group. operationId: DeleteDynamicResourceGroup 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: dynamicResourceGroupId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/DynamicResourceGroup' get: description: Get a Dynamic Resource Group. operationId: GetDynamicResourceGroup 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: dynamicResourceGroupId 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/DynamicResourceGroup' application/scim+json: schema: $ref: '#/components/schemas/DynamicResourceGroup' '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 a Dynamic Resource Group. operationId: PatchDynamicResourceGroup 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: dynamicResourceGroupId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/DynamicResourceGroup' application/scim+json: schema: $ref: '#/components/schemas/DynamicResourceGroup' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the DynamicResourceGroup with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Dynamic Resource Group. operationId: PutDynamicResourceGroup 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: dynamicResourceGroupId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/DynamicResourceGroup' application/scim+json: schema: $ref: '#/components/schemas/DynamicResourceGroup' '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' '412': description: Preconditions in clients headers are not met by the server 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/DynamicResourceGroup' application/json: schema: $ref: '#/components/schemas/DynamicResourceGroup' description: "Replace the current instance of DynamicResourceGroup with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Grants: get: description: Search Grants operationId: ListGrants 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/Grants' application/scim+json: schema: $ref: '#/components/schemas/Grants' '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 post: description: Add a Grantee to an AppRole operationId: CreateGrant 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Grant' application/scim+json: schema: $ref: '#/components/schemas/Grant' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/Grant' application/json: schema: $ref: '#/components/schemas/Grant' description: "Grant schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Grants/.search: post: description: Search Grants Using POST operationId: SearchGrants 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/Grants' application/scim+json: schema: $ref: '#/components/schemas/Grants' '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/GrantSearchRequest' application/json: schema: $ref: '#/components/schemas/GrantSearchRequest' description: Parameters for searching Grants /admin/v1/Grants/{grantId}: delete: description: Remove a Grantee from an AppRole operationId: DeleteGrant 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: grantId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/Grant' get: description: Get a Grant operationId: GetGrant 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: grantId 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/Grant' application/scim+json: schema: $ref: '#/components/schemas/Grant' '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 a Grant operationId: PatchGrant 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: grantId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Grant' application/scim+json: schema: $ref: '#/components/schemas/Grant' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the Grant with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Groups: get: description: Search for groups. Important: The Group SEARCH and GET operations on users and members will throw an exception if the response has more than 10,000 members. To avoid the exception, use the pagination filter to GET or SEARCH group members. operationId: ListGroups 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/Groups' application/scim+json: schema: $ref: '#/components/schemas/Groups' '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 post: description: Create a group. operationId: CreateGroup 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Group' application/scim+json: schema: $ref: '#/components/schemas/Group' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/Group' application/json: schema: $ref: '#/components/schemas/Group' description: "Group schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Groups/.search: post: description: Search for groups using POST. operationId: SearchGroups 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/Groups' application/scim+json: schema: $ref: '#/components/schemas/Groups' '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/GroupSearchRequest' application/json: schema: $ref: '#/components/schemas/GroupSearchRequest' description: Parameters for searching Groups /admin/v1/Groups/{groupId}: delete: description: Delete a group. operationId: DeleteGroup 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: groupId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/Group' get: description: Get a group. Important: The Group SEARCH and GET operations on users and members will throw an exception if the response has more than 10,000 members. To avoid the exception, use the pagination filter to GET or SEARCH group members. operationId: GetGroup 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: groupId 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/Group' application/scim+json: schema: $ref: '#/components/schemas/Group' '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 a group. operationId: PatchGroup 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: groupId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Group' application/scim+json: schema: $ref: '#/components/schemas/Group' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the Group with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a group. operationId: PutGroup 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: groupId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Group' application/scim+json: schema: $ref: '#/components/schemas/Group' '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' '412': description: Preconditions in clients headers are not met by the server 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/Group' application/json: schema: $ref: '#/components/schemas/Group' description: "Replace the current instance of Group with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/IdentityPropagationTrusts: get: description: List the Identity Propagation Trust configurations. operationId: ListIdentityPropagationTrusts 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/IdentityPropagationTrusts' application/scim+json: schema: $ref: '#/components/schemas/IdentityPropagationTrusts' '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 post: description: Register a new Identity Propagation Trust configuration. operationId: CreateIdentityPropagationTrust 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/IdentityPropagationTrust' application/scim+json: schema: $ref: '#/components/schemas/IdentityPropagationTrust' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/IdentityPropagationTrust' application/json: schema: $ref: '#/components/schemas/IdentityPropagationTrust' description: "IdentityPropagationTrust schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/IdentityPropagationTrusts/{identityPropagationTrustId}: delete: description: Delete an existing Identity Propagation Trust configuration. operationId: DeleteIdentityPropagationTrust 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: identityPropagationTrustId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/IdentityPropagationTrust' get: description: Get an existing Identity Propagation Trust configuration. operationId: GetIdentityPropagationTrust 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: identityPropagationTrustId 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/IdentityPropagationTrust' application/scim+json: schema: $ref: '#/components/schemas/IdentityPropagationTrust' '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 existing Identity Propagation Trust configuration. operationId: PatchIdentityPropagationTrust 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: identityPropagationTrustId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/IdentityPropagationTrust' application/scim+json: schema: $ref: '#/components/schemas/IdentityPropagationTrust' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the IdentityPropagationTrust with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace an existing Identity Propagation Trust configuration. operationId: PutIdentityPropagationTrust 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: identityPropagationTrustId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/IdentityPropagationTrust' application/scim+json: schema: $ref: '#/components/schemas/IdentityPropagationTrust' '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' '412': description: Preconditions in clients headers are not met by the server 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/IdentityPropagationTrust' application/json: schema: $ref: '#/components/schemas/IdentityPropagationTrust' description: "Replace the current instance of IdentityPropagationTrust with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/IdentityProviders: get: description: Search Identity Providers operationId: ListIdentityProviders 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/IdentityProviders' application/scim+json: schema: $ref: '#/components/schemas/IdentityProviders' '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 post: description: Create an Identity Provider operationId: CreateIdentityProvider 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/IdentityProvider' application/scim+json: schema: $ref: '#/components/schemas/IdentityProvider' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/IdentityProvider' application/json: schema: $ref: '#/components/schemas/IdentityProvider' description: "IdentityProvider schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/IdentityProviders/.search: post: description: Search Identity Providers Using POST operationId: SearchIdentityProviders 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/IdentityProviders' application/scim+json: schema: $ref: '#/components/schemas/IdentityProviders' '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/IdentityProviderSearchRequest' application/json: schema: $ref: '#/components/schemas/IdentityProviderSearchRequest' description: Parameters for searching IdentityProviders /admin/v1/IdentityProviders/{identityProviderId}: delete: description: Delete an Identity Provider operationId: DeleteIdentityProvider 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: identityProviderId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/IdentityProvider' get: description: Get an Identity Provider operationId: GetIdentityProvider 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: identityProviderId 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/IdentityProvider' application/scim+json: schema: $ref: '#/components/schemas/IdentityProvider' '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 Identity Provider operationId: PatchIdentityProvider 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: identityProviderId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/IdentityProvider' application/scim+json: schema: $ref: '#/components/schemas/IdentityProvider' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the IdentityProvider with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace an Identity Provider operationId: PutIdentityProvider 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: identityProviderId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/IdentityProvider' application/scim+json: schema: $ref: '#/components/schemas/IdentityProvider' '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' '412': description: Preconditions in clients headers are not met by the server 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/IdentityProvider' application/json: schema: $ref: '#/components/schemas/IdentityProvider' description: "Replace the current instance of IdentityProvider with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/IdentitySettings: get: description: Search for Identity settings. operationId: ListIdentitySettings 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/IdentitySettings' application/scim+json: schema: $ref: '#/components/schemas/IdentitySettings' '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/IdentitySettings/.search: post: description: Search for Identity settings using POST. operationId: SearchIdentitySettings 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/IdentitySettings' application/scim+json: schema: $ref: '#/components/schemas/IdentitySettings' '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/IdentitySettingsSearchRequest' application/json: schema: $ref: '#/components/schemas/IdentitySettingsSearchRequest' description: Parameters for searching IdentitySettings /admin/v1/IdentitySettings/{identitySettingId}: get: description: Get an Identity setting. operationId: GetIdentitySetting 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: identitySettingId 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/IdentitySetting' application/scim+json: schema: $ref: '#/components/schemas/IdentitySetting' '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 Identity setting. operationId: PatchIdentitySetting 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: identitySettingId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/IdentitySetting' application/scim+json: schema: $ref: '#/components/schemas/IdentitySetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the IdentitySettings with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace an Identity setting. operationId: PutIdentitySetting 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: identitySettingId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/IdentitySetting' application/scim+json: schema: $ref: '#/components/schemas/IdentitySetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/IdentitySetting' application/json: schema: $ref: '#/components/schemas/IdentitySetting' description: "Replace the current instance of IdentitySettings with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/KmsiSettings: get: description: Search KmsiSettings operationId: ListKmsiSettings 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/KmsiSettings' application/scim+json: schema: $ref: '#/components/schemas/KmsiSettings' '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/KmsiSettings/.search: post: description: Search KmsiSettings Using POST operationId: SearchKmsiSettings 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/KmsiSettings' application/scim+json: schema: $ref: '#/components/schemas/KmsiSettings' '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/KmsiSettingsSearchRequest' application/json: schema: $ref: '#/components/schemas/KmsiSettingsSearchRequest' description: Parameters for searching KmsiSettings /admin/v1/KmsiSettings/{kmsiSettingId}: get: description: Get KmsiSettings operationId: GetKmsiSetting 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: kmsiSettingId 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/KmsiSetting' application/scim+json: schema: $ref: '#/components/schemas/KmsiSetting' '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 a Setting operationId: PatchKmsiSetting 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: kmsiSettingId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/KmsiSetting' application/scim+json: schema: $ref: '#/components/schemas/KmsiSetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the KmsiSettings with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace KmsiSettings operationId: PutKmsiSetting 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: kmsiSettingId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/KmsiSetting' application/scim+json: schema: $ref: '#/components/schemas/KmsiSetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/KmsiSetting' application/json: schema: $ref: '#/components/schemas/KmsiSetting' description: "Replace the current instance of KmsiSettings with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MappedAttributes: get: description: Search Mapped Attributes operationId: ListMappedAttributes 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/MappedAttributes' application/scim+json: schema: $ref: '#/components/schemas/MappedAttributes' '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 x-related-resource: '#/definitions/MappedAttribute' /admin/v1/MappedAttributes/.search: post: description: Search Mapped Attributes Using POST operationId: SearchMappedAttributes 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/MappedAttributes' application/scim+json: schema: $ref: '#/components/schemas/MappedAttributes' '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 x-related-resource: '#/definitions/MappedAttribute' requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MappedAttributeSearchRequest' application/json: schema: $ref: '#/components/schemas/MappedAttributeSearchRequest' description: Parameters for searching MappedAttributes /admin/v1/MappedAttributes/{mappedAttributeId}: get: description: Get Attribute Mappings for a Mapped Attribute operationId: GetMappedAttribute 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: mappedAttributeId 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/MappedAttribute' application/scim+json: schema: $ref: '#/components/schemas/MappedAttribute' '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 a Mapped Attribute operationId: PatchMappedAttribute 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: mappedAttributeId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MappedAttribute' application/scim+json: schema: $ref: '#/components/schemas/MappedAttribute' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MappedAttribute with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Mapped Attribute operationId: PutMappedAttribute 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: mappedAttributeId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MappedAttribute' application/scim+json: schema: $ref: '#/components/schemas/MappedAttribute' '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' '412': description: Preconditions in clients headers are not met by the server 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/MappedAttribute' application/json: schema: $ref: '#/components/schemas/MappedAttribute' description: "Replace the current instance of MappedAttribute with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Me: get: description: Get a user's own information. operationId: GetMe 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: 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/Me' application/scim+json: schema: $ref: '#/components/schemas/Me' '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 a user's own information. operationId: PatchMe 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: 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Me' application/scim+json: schema: $ref: '#/components/schemas/Me' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the Me with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" post: description: Self register a user. operationId: CreateMe 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Me' application/scim+json: schema: $ref: '#/components/schemas/Me' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/Me' application/json: schema: $ref: '#/components/schemas/Me' description: "Me schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a user's own information. operationId: PutMe 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: 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Me' application/scim+json: schema: $ref: '#/components/schemas/Me' '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' '412': description: Preconditions in clients headers are not met by the server 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/Me' application/json: schema: $ref: '#/components/schemas/Me' description: "Replace the current instance of Me with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MePasswordChanger: put: description: Update a user's own password. operationId: PutMePasswordChanger 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: 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MePasswordChanger' application/scim+json: schema: $ref: '#/components/schemas/MePasswordChanger' '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' '412': description: Preconditions in clients headers are not met by the server 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/MePasswordChanger' application/json: schema: $ref: '#/components/schemas/MePasswordChanger' description: "Replace the current instance of MePasswordChanger with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyApiKeys: get: description: Search for a user's own API key. operationId: ListMyApiKeys 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: 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/MyApiKeys' application/scim+json: schema: $ref: '#/components/schemas/MyApiKeys' '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 post: description: Add a user's own API key. operationId: CreateMyApiKey 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyApiKey' application/scim+json: schema: $ref: '#/components/schemas/MyApiKey' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyApiKey' application/json: schema: $ref: '#/components/schemas/MyApiKey' description: "MyApiKey schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyApiKeys/{myApiKeyId}: delete: description: Delete a user's own API key. operationId: DeleteMyApiKey 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: myApiKeyId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MyApiKey' get: description: Get a user's own API key. operationId: GetMyApiKey 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: ID of the resource in: path name: myApiKeyId 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/MyApiKey' application/scim+json: schema: $ref: '#/components/schemas/MyApiKey' '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 a user's own API key. operationId: PatchMyApiKey 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: ID of the resource in: path name: myApiKeyId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyApiKey' application/scim+json: schema: $ref: '#/components/schemas/MyApiKey' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MyApiKey with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyApps: get: description: Search My Apps operationId: ListMyApps 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: 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/MyApps' application/scim+json: schema: $ref: '#/components/schemas/MyApps' '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/MyApps/.search: post: description: Search My Apps Using POST operationId: SearchMyApps 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/MyApps' application/scim+json: schema: $ref: '#/components/schemas/MyApps' '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/MyAppSearchRequest' application/json: schema: $ref: '#/components/schemas/MyAppSearchRequest' description: Parameters for searching MyApps /admin/v1/MyAuthTokens: get: description: Search for a user's own Auth token. operationId: ListMyAuthTokens 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: 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/MyAuthTokens' application/scim+json: schema: $ref: '#/components/schemas/MyAuthTokens' '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 post: description: Create a user's own Auth token. operationId: CreateMyAuthToken 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyAuthToken' application/scim+json: schema: $ref: '#/components/schemas/MyAuthToken' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyAuthToken' application/json: schema: $ref: '#/components/schemas/MyAuthToken' description: "MyAuthToken schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyAuthTokens/{myAuthTokenId}: delete: description: Delete a user's own Auth token. operationId: DeleteMyAuthToken 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: myAuthTokenId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MyAuthToken' get: description: Get a user's own Auth token. operationId: GetMyAuthToken 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: ID of the resource in: path name: myAuthTokenId 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/MyAuthToken' application/scim+json: schema: $ref: '#/components/schemas/MyAuthToken' '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 a user's own Auth token. operationId: PatchMyAuthToken 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: ID of the resource in: path name: myAuthTokenId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyAuthToken' application/scim+json: schema: $ref: '#/components/schemas/MyAuthToken' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MyAuthToken with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyAuthenticationFactorInitiator: post: description: Initiate Self Service Enrollment using the Requested MFA Factor operationId: CreateMyAuthenticationFactorInitiator 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyAuthenticationFactorInitiator' application/scim+json: schema: $ref: '#/components/schemas/MyAuthenticationFactorInitiator' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyAuthenticationFactorInitiator' application/json: schema: $ref: '#/components/schemas/MyAuthenticationFactorInitiator' description: "MyAuthenticationFactorInitiator schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyAuthenticationFactorValidator: post: description: Validate Self Service Enrollment using the Requested MFA Factor operationId: CreateMyAuthenticationFactorValidator 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyAuthenticationFactorValidator' application/scim+json: schema: $ref: '#/components/schemas/MyAuthenticationFactorValidator' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyAuthenticationFactorValidator' application/json: schema: $ref: '#/components/schemas/MyAuthenticationFactorValidator' description: "MyAuthenticationFactorValidator schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyAuthenticationFactorsRemover: post: description: Remove All Authentication Factor Channels for a User operationId: CreateMyAuthenticationFactorsRemover 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyAuthenticationFactorsRemover' application/scim+json: schema: $ref: '#/components/schemas/MyAuthenticationFactorsRemover' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyAuthenticationFactorsRemover' application/json: schema: $ref: '#/components/schemas/MyAuthenticationFactorsRemover' description: "MyAuthenticationFactorsRemover schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyCompletedApprovals: get: description: Search My MyCompletedApproval operationId: ListMyCompletedApprovals 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: 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/MyCompletedApprovals' application/scim+json: schema: $ref: '#/components/schemas/MyCompletedApprovals' '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/MyCompletedApprovals/{myCompletedApprovalId}: get: description: Get My MyCompletedApproval operationId: GetMyCompletedApproval 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: ID of the resource in: path name: myCompletedApprovalId 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/MyCompletedApproval' application/scim+json: schema: $ref: '#/components/schemas/MyCompletedApproval' '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/MyCustomerSecretKeys: get: description: Search for a user's own customer secret key. operationId: ListMyCustomerSecretKeys 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: 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/MyCustomerSecretKeys' application/scim+json: schema: $ref: '#/components/schemas/MyCustomerSecretKeys' '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 post: description: Add a user's own customer secret key. operationId: CreateMyCustomerSecretKey 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyCustomerSecretKey' application/scim+json: schema: $ref: '#/components/schemas/MyCustomerSecretKey' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyCustomerSecretKey' application/json: schema: $ref: '#/components/schemas/MyCustomerSecretKey' description: "MyCustomerSecretKey schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyCustomerSecretKeys/{myCustomerSecretKeyId}: delete: description: Delete a user's own customer secret key. operationId: DeleteMyCustomerSecretKey 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: myCustomerSecretKeyId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MyCustomerSecretKey' get: description: Get a user's own customer secret key. operationId: GetMyCustomerSecretKey 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: ID of the resource in: path name: myCustomerSecretKeyId 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/MyCustomerSecretKey' application/scim+json: schema: $ref: '#/components/schemas/MyCustomerSecretKey' '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 a user's own customer secret key. operationId: PatchMyCustomerSecretKey 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: ID of the resource in: path name: myCustomerSecretKeyId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyCustomerSecretKey' application/scim+json: schema: $ref: '#/components/schemas/MyCustomerSecretKey' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MyCustomerSecretKey with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyDevices: get: description: Search Devices operationId: ListMyDevices 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/MyDevices' application/scim+json: schema: $ref: '#/components/schemas/MyDevices' '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/MyDevices/{myDeviceId}: delete: description: Delete a Device operationId: DeleteMyDevice 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: myDeviceId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MyDevice' get: description: Get a Device operationId: GetMyDevice 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: myDeviceId 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/MyDevice' application/scim+json: schema: $ref: '#/components/schemas/MyDevice' '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 a Device operationId: PatchMyDevice 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: myDeviceId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyDevice' application/scim+json: schema: $ref: '#/components/schemas/MyDevice' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MyDevice with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyGroups: get: description: Search for 'My Groups'. operationId: ListMyGroups 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/MyGroups' application/scim+json: schema: $ref: '#/components/schemas/MyGroups' '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/MyGroups/.search: post: description: Search for 'My Groups' using POST. operationId: SearchMyGroups 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/MyGroups' application/scim+json: schema: $ref: '#/components/schemas/MyGroups' '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/MyGroupSearchRequest' application/json: schema: $ref: '#/components/schemas/MyGroupSearchRequest' description: Parameters for searching MyGroups /admin/v1/MyOAuth2ClientCredentials: get: description: Search for a user's own OAuth2 client credential. operationId: ListMyOAuth2ClientCredentials 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: 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/MyOAuth2ClientCredentials' application/scim+json: schema: $ref: '#/components/schemas/MyOAuth2ClientCredentials' '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 post: description: Create a user's own OAuth2 client credential. operationId: CreateMyOAuth2ClientCredential 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyOAuth2ClientCredential' application/scim+json: schema: $ref: '#/components/schemas/MyOAuth2ClientCredential' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyOAuth2ClientCredential' application/json: schema: $ref: '#/components/schemas/MyOAuth2ClientCredential' description: "MyOAuth2ClientCredential schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyOAuth2ClientCredentials/{myOAuth2ClientCredentialId}: delete: description: Delete a user's own OAuth2 client credential. operationId: DeleteMyOAuth2ClientCredential 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: myOAuth2ClientCredentialId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MyOAuth2ClientCredential' get: description: Get a user's own OAuth2 client credential. operationId: GetMyOAuth2ClientCredential 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: ID of the resource in: path name: myOAuth2ClientCredentialId 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/MyOAuth2ClientCredential' application/scim+json: schema: $ref: '#/components/schemas/MyOAuth2ClientCredential' '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 a user's own OAuth2 client credential. operationId: PatchMyOAuth2ClientCredential 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: ID of the resource in: path name: myOAuth2ClientCredentialId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyOAuth2ClientCredential' application/scim+json: schema: $ref: '#/components/schemas/MyOAuth2ClientCredential' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MyOAuth2ClientCredential with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyPendingApprovals: get: description: Search My Approvals operationId: ListMyPendingApprovals 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: 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/MyPendingApprovals' application/scim+json: schema: $ref: '#/components/schemas/MyPendingApprovals' '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/MyPendingApprovals/{myPendingApprovalId}: get: description: Get My MyPendingApproval operationId: GetMyPendingApproval 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: ID of the resource in: path name: myPendingApprovalId 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/MyPendingApproval' application/scim+json: schema: $ref: '#/components/schemas/MyPendingApproval' '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 MyPendingApproval operationId: PatchMyPendingApproval 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: ID of the resource in: path name: myPendingApprovalId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyPendingApproval' application/scim+json: schema: $ref: '#/components/schemas/MyPendingApproval' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MyPendingApproval with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyRequestableGroups: get: description: Search My Requestable Groups operationId: ListMyRequestableGroups 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: 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/MyRequestableGroups' application/scim+json: schema: $ref: '#/components/schemas/MyRequestableGroups' '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/MyRequestableGroups/.search: post: description: Search My Requestable Groups Using POST operationId: SearchMyRequestableGroups 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/MyRequestableGroups' application/scim+json: schema: $ref: '#/components/schemas/MyRequestableGroups' '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/MyRequestableGroupSearchRequest' application/json: schema: $ref: '#/components/schemas/MyRequestableGroupSearchRequest' description: Parameters for searching MyRequestableGroups /admin/v1/MyRequests: get: description: Search My Requests operationId: ListMyRequests 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/MyRequests' application/scim+json: schema: $ref: '#/components/schemas/MyRequests' '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 post: description: Create a Request operationId: CreateMyRequest 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyRequest' application/scim+json: schema: $ref: '#/components/schemas/MyRequest' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyRequest' application/json: schema: $ref: '#/components/schemas/MyRequest' description: "MyRequest schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyRequests/.search: post: description: Search My Requests Using POST operationId: SearchMyRequests 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/MyRequests' application/scim+json: schema: $ref: '#/components/schemas/MyRequests' '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/MyRequestSearchRequest' application/json: schema: $ref: '#/components/schemas/MyRequestSearchRequest' description: Parameters for searching MyRequests /admin/v1/MyRequests/{myRequestId}: get: description: Get My Requests operationId: GetMyRequest 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: myRequestId 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/MyRequest' application/scim+json: schema: $ref: '#/components/schemas/MyRequest' '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 My Requests operationId: PatchMyRequest 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: myRequestId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyRequest' application/scim+json: schema: $ref: '#/components/schemas/MyRequest' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MyRequest with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MySmtpCredentials: get: description: Search for a user's own SMTP credential. operationId: ListMySmtpCredentials 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: 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/MySmtpCredentials' application/scim+json: schema: $ref: '#/components/schemas/MySmtpCredentials' '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 post: description: Create a user's own SMTP credential. operationId: CreateMySmtpCredential 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MySmtpCredential' application/scim+json: schema: $ref: '#/components/schemas/MySmtpCredential' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MySmtpCredential' application/json: schema: $ref: '#/components/schemas/MySmtpCredential' description: "MySmtpCredential schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MySmtpCredentials/{mySmtpCredentialId}: delete: description: Delete a user's own SMTP credential. operationId: DeleteMySmtpCredential 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: mySmtpCredentialId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MySmtpCredential' get: description: Get a user's own SMTP credential. operationId: GetMySmtpCredential 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: ID of the resource in: path name: mySmtpCredentialId 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/MySmtpCredential' application/scim+json: schema: $ref: '#/components/schemas/MySmtpCredential' '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 a user's own SMTP credential. operationId: PatchMySmtpCredential 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: ID of the resource in: path name: mySmtpCredentialId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MySmtpCredential' application/scim+json: schema: $ref: '#/components/schemas/MySmtpCredential' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the MySmtpCredential with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MySupportAccounts: get: description: Search for a user's own support account. operationId: ListMySupportAccounts 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: 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/MySupportAccounts' application/scim+json: schema: $ref: '#/components/schemas/MySupportAccounts' '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 post: description: Create a user's own support account. operationId: CreateMySupportAccount 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MySupportAccount' application/scim+json: schema: $ref: '#/components/schemas/MySupportAccount' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MySupportAccount' application/json: schema: $ref: '#/components/schemas/MySupportAccount' description: "MySupportAccount schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MySupportAccounts/{mySupportAccountId}: delete: description: Delete a user's own support account. operationId: DeleteMySupportAccount 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: mySupportAccountId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MySupportAccount' get: description: Get a user's own support account. operationId: GetMySupportAccount 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: ID of the resource in: path name: mySupportAccountId 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/MySupportAccount' application/scim+json: schema: $ref: '#/components/schemas/MySupportAccount' '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/MyTrustedUserAgents: get: description: Search Trusted User Agents operationId: ListMyTrustedUserAgents 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/MyTrustedUserAgents' application/scim+json: schema: $ref: '#/components/schemas/MyTrustedUserAgents' '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/MyTrustedUserAgents/{myTrustedUserAgentId}: delete: description: Delete a Trusted User Agent operationId: DeleteMyTrustedUserAgent 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: myTrustedUserAgentId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MyTrustedUserAgent' get: description: Get a Trusted User Agent operationId: GetMyTrustedUserAgent 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: myTrustedUserAgentId 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/MyTrustedUserAgent' application/scim+json: schema: $ref: '#/components/schemas/MyTrustedUserAgent' '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/MyUserDbCredentials: get: description: Search for a user's own database (DB) credential. operationId: ListMyUserDbCredentials 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: 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/MyUserDbCredentials' application/scim+json: schema: $ref: '#/components/schemas/MyUserDbCredentials' '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 post: description: Create a user's own database (DB) credential. operationId: CreateMyUserDbCredential 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/MyUserDbCredential' application/scim+json: schema: $ref: '#/components/schemas/MyUserDbCredential' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/MyUserDbCredential' application/json: schema: $ref: '#/components/schemas/MyUserDbCredential' description: "MyUserDbCredentials schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/MyUserDbCredentials/{myUserDbCredentialId}: delete: description: Delete a user's own database (DB) credential. operationId: DeleteMyUserDbCredential 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: myUserDbCredentialId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/MyUserDbCredential' get: description: Get a user's own database (DB) credential. operationId: GetMyUserDbCredential 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: ID of the resource in: path name: myUserDbCredentialId 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/MyUserDbCredential' application/scim+json: schema: $ref: '#/components/schemas/MyUserDbCredential' '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/NetworkPerimeters: get: description: Search NetworkPerimeters operationId: ListNetworkPerimeters 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/NetworkPerimeters' application/scim+json: schema: $ref: '#/components/schemas/NetworkPerimeters' '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 post: description: Create a NetworkPerimeter operationId: CreateNetworkPerimeter 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/NetworkPerimeter' application/scim+json: schema: $ref: '#/components/schemas/NetworkPerimeter' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/NetworkPerimeter' application/json: schema: $ref: '#/components/schemas/NetworkPerimeter' description: "NetworkPerimeter schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/NetworkPerimeters/.search: post: description: Search NetworkPerimeters Using POST operationId: SearchNetworkPerimeters 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/NetworkPerimeters' application/scim+json: schema: $ref: '#/components/schemas/NetworkPerimeters' '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/NetworkPerimeterSearchRequest' application/json: schema: $ref: '#/components/schemas/NetworkPerimeterSearchRequest' description: Parameters for searching NetworkPerimeters /admin/v1/NetworkPerimeters/{networkPerimeterId}: delete: description: Delete a NetworkPerimeter operationId: DeleteNetworkPerimeter 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: networkPerimeterId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/NetworkPerimeter' get: description: Get a NetworkPerimeter operationId: GetNetworkPerimeter 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: networkPerimeterId 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/NetworkPerimeter' application/scim+json: schema: $ref: '#/components/schemas/NetworkPerimeter' '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 a NetworkPerimeter operationId: PatchNetworkPerimeter 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: networkPerimeterId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/NetworkPerimeter' application/scim+json: schema: $ref: '#/components/schemas/NetworkPerimeter' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the NetworkPerimeter with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a NetworkPerimeter operationId: PutNetworkPerimeter 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: networkPerimeterId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/NetworkPerimeter' application/scim+json: schema: $ref: '#/components/schemas/NetworkPerimeter' '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' '412': description: Preconditions in clients headers are not met by the server 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/NetworkPerimeter' application/json: schema: $ref: '#/components/schemas/NetworkPerimeter' description: "Replace the current instance of NetworkPerimeter with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/NotificationSettings: get: description: Search Notification Settings operationId: ListNotificationSettings 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/NotificationSettings' application/scim+json: schema: $ref: '#/components/schemas/NotificationSettings' '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/NotificationSettings/.search: post: description: Search Notification Settings Using POST operationId: SearchNotificationSettings 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/NotificationSettings' application/scim+json: schema: $ref: '#/components/schemas/NotificationSettings' '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/NotificationSettingsSearchRequest' application/json: schema: $ref: '#/components/schemas/NotificationSettingsSearchRequest' description: Parameters for searching NotificationSettings /admin/v1/NotificationSettings/{notificationSettingId}: get: description: Get Notification Settings operationId: GetNotificationSetting 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: notificationSettingId 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/NotificationSetting' application/scim+json: schema: $ref: '#/components/schemas/NotificationSetting' '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 put: description: Replace Notification Settings operationId: PutNotificationSetting 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: notificationSettingId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/NotificationSetting' application/scim+json: schema: $ref: '#/components/schemas/NotificationSetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/NotificationSetting' application/json: schema: $ref: '#/components/schemas/NotificationSetting' description: "Replace the current instance of NotificationSettings with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/OAuth2ClientCredentials: get: description: Search for a user's OAuth2 client credentials. operationId: ListOAuth2ClientCredentials 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/OAuth2ClientCredentials' application/scim+json: schema: $ref: '#/components/schemas/OAuth2ClientCredentials' '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 post: description: Add a user's OAuth2 client credentials. operationId: CreateOAuth2ClientCredential 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/OAuth2ClientCredential' application/scim+json: schema: $ref: '#/components/schemas/OAuth2ClientCredential' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/OAuth2ClientCredential' application/json: schema: $ref: '#/components/schemas/OAuth2ClientCredential' description: "OAuth2ClientCredential schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/OAuth2ClientCredentials/.search: post: description: Search for OAuth2 client credentials using POST. operationId: SearchOAuth2ClientCredentials 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/OAuth2ClientCredentials' application/scim+json: schema: $ref: '#/components/schemas/OAuth2ClientCredentials' '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/OAuth2ClientCredentialSearchRequest' application/json: schema: $ref: '#/components/schemas/OAuth2ClientCredentialSearchRequest' description: Parameters for searching OAuth2ClientCredentials /admin/v1/OAuth2ClientCredentials/{oAuth2ClientCredentialId}: delete: description: Delete a user's OAuth2 client credentials. operationId: DeleteOAuth2ClientCredential 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: oAuth2ClientCredentialId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/OAuth2ClientCredential' get: description: Get a user's OAuth2 client credentials. operationId: GetOAuth2ClientCredential 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: oAuth2ClientCredentialId 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/OAuth2ClientCredential' application/scim+json: schema: $ref: '#/components/schemas/OAuth2ClientCredential' '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 a user's OAuth2 client credentials. operationId: PatchOAuth2ClientCredential 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: oAuth2ClientCredentialId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/OAuth2ClientCredential' application/scim+json: schema: $ref: '#/components/schemas/OAuth2ClientCredential' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the OAuth2ClientCredential with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/OAuthClientCertificates: get: description: Search OAuth Client Certificates operationId: ListOAuthClientCertificates 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: 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/OAuthClientCertificates' application/scim+json: schema: $ref: '#/components/schemas/OAuthClientCertificates' '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 post: description: Create an OAuth Client Certificate operationId: CreateOAuthClientCertificate 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/OAuthClientCertificate' application/scim+json: schema: $ref: '#/components/schemas/OAuthClientCertificate' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/OAuthClientCertificate' application/json: schema: $ref: '#/components/schemas/OAuthClientCertificate' description: "OAuthClientCertificate schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/OAuthClientCertificates/.search: post: description: Search OAuth Client Certificates Using POST operationId: SearchOAuthClientCertificates 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/OAuthClientCertificates' application/scim+json: schema: $ref: '#/components/schemas/OAuthClientCertificates' '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/OAuthClientCertificateSearchRequest' application/json: schema: $ref: '#/components/schemas/OAuthClientCertificateSearchRequest' description: Parameters for searching OAuthClientCertificates /admin/v1/OAuthClientCertificates/{oAuthClientCertificateId}: delete: description: Delete an OAuth Client Certificate operationId: DeleteOAuthClientCertificate 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: oAuthClientCertificateId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/OAuthClientCertificate' get: description: Get OAuth Client Certificates operationId: GetOAuthClientCertificate 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: ID of the resource in: path name: oAuthClientCertificateId 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/OAuthClientCertificate' application/scim+json: schema: $ref: '#/components/schemas/OAuthClientCertificate' '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/OAuthPartnerCertificates: get: description: Search OAuth Partner Certificates operationId: ListOAuthPartnerCertificates 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: 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/OAuthPartnerCertificates' application/scim+json: schema: $ref: '#/components/schemas/OAuthPartnerCertificates' '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 post: description: Create an OAuth Partner Certificate operationId: CreateOAuthPartnerCertificate 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/OAuthPartnerCertificate' application/scim+json: schema: $ref: '#/components/schemas/OAuthPartnerCertificate' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/OAuthPartnerCertificate' application/json: schema: $ref: '#/components/schemas/OAuthPartnerCertificate' description: "OAuthPartnerCertificate schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/OAuthPartnerCertificates/.search: post: description: Search OAuth Partner Certificates Using POST operationId: SearchOAuthPartnerCertificates 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/OAuthPartnerCertificates' application/scim+json: schema: $ref: '#/components/schemas/OAuthPartnerCertificates' '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/OAuthPartnerCertificateSearchRequest' application/json: schema: $ref: '#/components/schemas/OAuthPartnerCertificateSearchRequest' description: Parameters for searching OAuthPartnerCertificates /admin/v1/OAuthPartnerCertificates/{oAuthPartnerCertificateId}: delete: description: Delete an OAuth Partner Certificate operationId: DeleteOAuthPartnerCertificate 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: oAuthPartnerCertificateId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/OAuthPartnerCertificate' get: description: Get an OAuth Partner Certificate operationId: GetOAuthPartnerCertificate 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: ID of the resource in: path name: oAuthPartnerCertificateId 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/OAuthPartnerCertificate' application/scim+json: schema: $ref: '#/components/schemas/OAuthPartnerCertificate' '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/OciConsoleSignOnPolicyConsents: get: description: Search OciConsoleSignOnPolicyConsent entries operationId: ListOciConsoleSignOnPolicyConsents 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/OciConsoleSignOnPolicyConsents' application/scim+json: schema: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsents' '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 x-related-resource: '#/definitions/OciConsoleSignOnPolicyConsent' /admin/v1/OciConsoleSignOnPolicyConsents/.search: post: description: Search OciConsoleSignOnPolicyConsents Using POST operationId: SearchOciConsoleSignOnPolicyConsents 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/OciConsoleSignOnPolicyConsents' application/scim+json: schema: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsents' '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 x-related-resource: '#/definitions/OciConsoleSignOnPolicyConsent' requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsentSearchRequest' application/json: schema: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsentSearchRequest' description: Parameters for searching OciConsoleSignOnPolicyConsents /admin/v1/OciConsoleSignOnPolicyConsents/{ociConsoleSignOnPolicyConsentId}: get: description: Get a OciConsoleSignOnPolicyConsent Entry. operationId: GetOciConsoleSignOnPolicyConsent 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: ociConsoleSignOnPolicyConsentId 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/OciConsoleSignOnPolicyConsent' application/scim+json: schema: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsent' '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/PasswordPolicies: get: description: Search for password policies. operationId: ListPasswordPolicies 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/PasswordPolicies' application/scim+json: schema: $ref: '#/components/schemas/PasswordPolicies' '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 post: description: Create a password policy. operationId: CreatePasswordPolicy 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/PasswordPolicy' application/scim+json: schema: $ref: '#/components/schemas/PasswordPolicy' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/PasswordPolicy' application/json: schema: $ref: '#/components/schemas/PasswordPolicy' description: "PasswordPolicy schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/PasswordPolicies/.search: post: description: Search for password policies using POST. operationId: SearchPasswordPolicies 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/PasswordPolicies' application/scim+json: schema: $ref: '#/components/schemas/PasswordPolicies' '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/PasswordPolicySearchRequest' application/json: schema: $ref: '#/components/schemas/PasswordPolicySearchRequest' description: Parameters for searching PasswordPolicies /admin/v1/PasswordPolicies/{passwordPolicyId}: delete: description: Delete a password policy. operationId: DeletePasswordPolicy 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: passwordPolicyId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/PasswordPolicy' get: description: Get a password policy. operationId: GetPasswordPolicy 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: passwordPolicyId 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/PasswordPolicy' application/scim+json: schema: $ref: '#/components/schemas/PasswordPolicy' '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 a password policy. operationId: PatchPasswordPolicy 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: passwordPolicyId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/PasswordPolicy' application/scim+json: schema: $ref: '#/components/schemas/PasswordPolicy' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the PasswordPolicy with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a password policy. operationId: PutPasswordPolicy 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: passwordPolicyId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/PasswordPolicy' application/scim+json: schema: $ref: '#/components/schemas/PasswordPolicy' '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' '412': description: Preconditions in clients headers are not met by the server 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/PasswordPolicy' application/json: schema: $ref: '#/components/schemas/PasswordPolicy' description: "Replace the current instance of PasswordPolicy with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Policies: get: description: Search Policies. operationId: ListPolicies 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/Policies' application/scim+json: schema: $ref: '#/components/schemas/Policies' '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 x-related-resource: '#/definitions/Policy' post: description: Create a Policy. operationId: CreatePolicy 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Policy' application/scim+json: schema: $ref: '#/components/schemas/Policy' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/Policy' application/json: schema: $ref: '#/components/schemas/Policy' description: "Policy schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Policies/.search: post: description: Search Policies Using POST operationId: SearchPolicies 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/Policies' application/scim+json: schema: $ref: '#/components/schemas/Policies' '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 x-related-resource: '#/definitions/Policy' requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/PolicySearchRequest' application/json: schema: $ref: '#/components/schemas/PolicySearchRequest' description: Parameters for searching Policies /admin/v1/Policies/{policyId}: delete: description: Delete a Policy. operationId: DeletePolicy 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: policyId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/Policy' get: description: Get a Policy. operationId: GetPolicy 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: policyId 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/Policy' application/scim+json: schema: $ref: '#/components/schemas/Policy' '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 a Policy. operationId: PatchPolicy 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: policyId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Policy' application/scim+json: schema: $ref: '#/components/schemas/Policy' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the Policy with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Policy. operationId: PutPolicy 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: policyId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Policy' application/scim+json: schema: $ref: '#/components/schemas/Policy' '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' '412': description: Preconditions in clients headers are not met by the server 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/Policy' application/json: schema: $ref: '#/components/schemas/Policy' description: "Replace the current instance of Policy with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/ResourceTypeSchemaAttributes: get: description: Search Resource Type Schema Attributes operationId: ListResourceTypeSchemaAttributes 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/ResourceTypeSchemaAttributes' application/scim+json: schema: $ref: '#/components/schemas/ResourceTypeSchemaAttributes' '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/ResourceTypeSchemaAttributes/.search: post: description: Search Resource Type Schema Attributes Using POST operationId: SearchResourceTypeSchemaAttributes 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/ResourceTypeSchemaAttributes' application/scim+json: schema: $ref: '#/components/schemas/ResourceTypeSchemaAttributes' '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/ResourceTypeSchemaAttributeSearchRequest' application/json: schema: $ref: '#/components/schemas/ResourceTypeSchemaAttributeSearchRequest' description: Parameters for searching ResourceTypeSchemaAttributes /admin/v1/RestoreOciConsolePolicy: post: description: Create a RestoreOciConsolePolicy entry to restore Policy to factory default. operationId: CreateRestoreOciConsolePolicy 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/RestoreOciConsolePolicy' application/scim+json: schema: $ref: '#/components/schemas/RestoreOciConsolePolicy' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/RestoreOciConsolePolicy' application/json: schema: $ref: '#/components/schemas/RestoreOciConsolePolicy' description: "RestoreOciConsolePolicy schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Rules: get: description: Search Rules. operationId: ListRules 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/Rules' application/scim+json: schema: $ref: '#/components/schemas/Rules' '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 x-related-resource: '#/definitions/Rule' post: description: Create a Rule. operationId: CreateRule 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Rule' application/scim+json: schema: $ref: '#/components/schemas/Rule' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/Rule' application/json: schema: $ref: '#/components/schemas/Rule' description: "Rule schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Rules/.search: post: description: Search Rules Using POST. operationId: SearchRules 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/Rules' application/scim+json: schema: $ref: '#/components/schemas/Rules' '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 x-related-resource: '#/definitions/Rule' requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/RuleSearchRequest' application/json: schema: $ref: '#/components/schemas/RuleSearchRequest' description: Parameters for searching Rules /admin/v1/Rules/{ruleId}: delete: description: Delete a Rule. operationId: DeleteRule 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: ruleId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/Rule' get: description: Get a Rule. operationId: GetRule 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: ruleId 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/Rule' application/scim+json: schema: $ref: '#/components/schemas/Rule' '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 a Rule. operationId: PatchRule 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: ruleId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Rule' application/scim+json: schema: $ref: '#/components/schemas/Rule' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the Rule with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Rule. operationId: PutRule 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: ruleId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Rule' application/scim+json: schema: $ref: '#/components/schemas/Rule' '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' '412': description: Preconditions in clients headers are not met by the server 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/Rule' application/json: schema: $ref: '#/components/schemas/Rule' description: "Replace the current instance of Rule with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Schemas: get: description: Search Schemas operationId: ListSchemas parameters: - 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: 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/Schemas' application/scim+json: schema: $ref: '#/components/schemas/Schemas' '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/Schemas/.search: post: description: Search Schemas Using POST operationId: SearchSchemas 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/Schemas' application/scim+json: schema: $ref: '#/components/schemas/Schemas' '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/SchemaSearchRequest' application/json: schema: $ref: '#/components/schemas/SchemaSearchRequest' description: Parameters for searching Schemas /admin/v1/Schemas/{schemaId}: get: description: Get a Schema operationId: GetSchema 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: ID of the resource in: path name: schemaId 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/Schema' application/scim+json: schema: $ref: '#/components/schemas/Schema' '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 a Schema Def operationId: PatchSchema 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: ID of the resource in: path name: schemaId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Schema' application/scim+json: schema: $ref: '#/components/schemas/Schema' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the Schema with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Schema Def operationId: PutSchema 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: ID of the resource in: path name: schemaId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Schema' application/scim+json: schema: $ref: '#/components/schemas/Schema' '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' '412': description: Preconditions in clients headers are not met by the server 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/Schema' application/json: schema: $ref: '#/components/schemas/Schema' description: "Replace the current instance of Schema with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SecurityQuestionSettings: get: description: Search for security question settings. operationId: ListSecurityQuestionSettings 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/SecurityQuestionSettings' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestionSettings' '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/SecurityQuestionSettings/.search: post: description: Search for security question settings using POST. operationId: SearchSecurityQuestionSettings 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/SecurityQuestionSettings' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestionSettings' '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/SecurityQuestionSettingsSearchRequest' application/json: schema: $ref: '#/components/schemas/SecurityQuestionSettingsSearchRequest' description: Parameters for searching SecurityQuestionSettings /admin/v1/SecurityQuestionSettings/{securityQuestionSettingId}: get: description: Get a security question setting. operationId: GetSecurityQuestionSetting 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: securityQuestionSettingId 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/SecurityQuestionSetting' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestionSetting' '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 a security question setting. operationId: PatchSecurityQuestionSetting 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: securityQuestionSettingId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SecurityQuestionSetting' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestionSetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the SecurityQuestionSettings with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a security question setting. operationId: PutSecurityQuestionSetting 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: securityQuestionSettingId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SecurityQuestionSetting' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestionSetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/SecurityQuestionSetting' application/json: schema: $ref: '#/components/schemas/SecurityQuestionSetting' description: "Replace the current instance of SecurityQuestionSettings with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SecurityQuestions: get: description: Search for security questions. operationId: ListSecurityQuestions 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/SecurityQuestions' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestions' '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 post: description: Create a security question. operationId: CreateSecurityQuestion 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SecurityQuestion' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestion' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestion' application/json: schema: $ref: '#/components/schemas/SecurityQuestion' description: "SecurityQuestion schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SecurityQuestions/.search: post: description: Search for security questions using POST. operationId: SearchSecurityQuestions 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/SecurityQuestions' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestions' '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/SecurityQuestionSearchRequest' application/json: schema: $ref: '#/components/schemas/SecurityQuestionSearchRequest' description: Parameters for searching SecurityQuestions /admin/v1/SecurityQuestions/{securityQuestionId}: delete: description: Delete a security question. operationId: DeleteSecurityQuestion 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: securityQuestionId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/SecurityQuestion' get: description: Get a security question. operationId: GetSecurityQuestion 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: securityQuestionId 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/SecurityQuestion' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestion' '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 a security question. operationId: PatchSecurityQuestion 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: securityQuestionId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SecurityQuestion' application/scim+json: schema: $ref: '#/components/schemas/SecurityQuestion' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the SecurityQuestion with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SelfRegistrationProfiles: get: description: Search for self-registration profiles. operationId: ListSelfRegistrationProfiles 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/SelfRegistrationProfiles' application/scim+json: schema: $ref: '#/components/schemas/SelfRegistrationProfiles' '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 post: description: Create a self-registration profile. operationId: CreateSelfRegistrationProfile 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SelfRegistrationProfile' application/scim+json: schema: $ref: '#/components/schemas/SelfRegistrationProfile' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/SelfRegistrationProfile' application/json: schema: $ref: '#/components/schemas/SelfRegistrationProfile' description: "SelfRegistrationProfile schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SelfRegistrationProfiles/.search: post: description: Search for self-registration profile using POST. operationId: SearchSelfRegistrationProfiles 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/SelfRegistrationProfiles' application/scim+json: schema: $ref: '#/components/schemas/SelfRegistrationProfiles' '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/SelfRegistrationProfileSearchRequest' application/json: schema: $ref: '#/components/schemas/SelfRegistrationProfileSearchRequest' description: Parameters for searching SelfRegistrationProfiles /admin/v1/SelfRegistrationProfiles/{selfRegistrationProfileId}: delete: description: Delete a self-registration profile. operationId: DeleteSelfRegistrationProfile 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: selfRegistrationProfileId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/SelfRegistrationProfile' get: description: Get a self-registration profile. operationId: GetSelfRegistrationProfile 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: selfRegistrationProfileId 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/SelfRegistrationProfile' application/scim+json: schema: $ref: '#/components/schemas/SelfRegistrationProfile' '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 a self-registration profile. operationId: PatchSelfRegistrationProfile 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: selfRegistrationProfileId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SelfRegistrationProfile' application/scim+json: schema: $ref: '#/components/schemas/SelfRegistrationProfile' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the SelfRegistrationProfile with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a self-registration profile. operationId: PutSelfRegistrationProfile 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: selfRegistrationProfileId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SelfRegistrationProfile' application/scim+json: schema: $ref: '#/components/schemas/SelfRegistrationProfile' '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' '412': description: Preconditions in clients headers are not met by the server 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/SelfRegistrationProfile' application/json: schema: $ref: '#/components/schemas/SelfRegistrationProfile' description: "Replace the current instance of SelfRegistrationProfile with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Settings: get: description: Search Settings operationId: ListSettings 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/Settings' application/scim+json: schema: $ref: '#/components/schemas/Settings' '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/Settings/.search: post: description: Search Settings Using POST operationId: SearchSettings 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/Settings' application/scim+json: schema: $ref: '#/components/schemas/Settings' '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/SettingsSearchRequest' application/json: schema: $ref: '#/components/schemas/SettingsSearchRequest' description: Parameters for searching Settings /admin/v1/Settings/{settingId}: get: description: Get Settings operationId: GetSetting 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: settingId 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/Setting' application/scim+json: schema: $ref: '#/components/schemas/Setting' '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 a Setting operationId: PatchSetting 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: settingId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Setting' application/scim+json: schema: $ref: '#/components/schemas/Setting' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the Settings with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace Settings operationId: PutSetting 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: settingId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/Setting' application/scim+json: schema: $ref: '#/components/schemas/Setting' '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' '412': description: Preconditions in clients headers are not met by the server 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/Setting' application/json: schema: $ref: '#/components/schemas/Setting' description: "Replace the current instance of Settings with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SmtpCredentials: get: description: Search for SMTP credentials. operationId: ListSmtpCredentials 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/SmtpCredentials' application/scim+json: schema: $ref: '#/components/schemas/SmtpCredentials' '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 post: description: Create a user's SMTP credentials. operationId: CreateSmtpCredential 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SmtpCredential' application/scim+json: schema: $ref: '#/components/schemas/SmtpCredential' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/SmtpCredential' application/json: schema: $ref: '#/components/schemas/SmtpCredential' description: "SmtpCredential schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SmtpCredentials/.search: post: description: Search for SMTP credentials using POST. operationId: SearchSmtpCredentials 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/SmtpCredentials' application/scim+json: schema: $ref: '#/components/schemas/SmtpCredentials' '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/SmtpCredentialSearchRequest' application/json: schema: $ref: '#/components/schemas/SmtpCredentialSearchRequest' description: Parameters for searching SmtpCredentials /admin/v1/SmtpCredentials/{smtpCredentialId}: delete: description: Delete a user's SMTP credentials. operationId: DeleteSmtpCredential 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: smtpCredentialId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/SmtpCredential' get: description: Get a user's SMTP credentials. operationId: GetSmtpCredential 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: smtpCredentialId 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/SmtpCredential' application/scim+json: schema: $ref: '#/components/schemas/SmtpCredential' '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 a user's SMTP credentials. operationId: PatchSmtpCredential 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: smtpCredentialId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SmtpCredential' application/scim+json: schema: $ref: '#/components/schemas/SmtpCredential' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the SmtpCredential with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SocialIdentityProviders: get: description: Search Social Identity Providers operationId: ListSocialIdentityProviders 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: 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/SocialIdentityProviders' application/scim+json: schema: $ref: '#/components/schemas/SocialIdentityProviders' '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 post: description: Create a Social Identity Provider operationId: CreateSocialIdentityProvider 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 responses: '201': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SocialIdentityProvider' application/scim+json: schema: $ref: '#/components/schemas/SocialIdentityProvider' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/SocialIdentityProvider' application/json: schema: $ref: '#/components/schemas/SocialIdentityProvider' description: "SocialIdentityProvider schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/SocialIdentityProviders/.search: post: description: Search Social Identity Providers Using POST operationId: SearchSocialIdentityProviders 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/SocialIdentityProviders' application/scim+json: schema: $ref: '#/components/schemas/SocialIdentityProviders' '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/SocialIdentityProviderSearchRequest' application/json: schema: $ref: '#/components/schemas/SocialIdentityProviderSearchRequest' description: Parameters for searching SocialIdentityProviders /admin/v1/SocialIdentityProviders/{socialIdentityProviderId}: delete: description: Delete a Social Identity Provider operationId: DeleteSocialIdentityProvider 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: socialIdentityProviderId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/SocialIdentityProvider' get: description: Get a Social Identity Provider operationId: GetSocialIdentityProvider 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: ID of the resource in: path name: socialIdentityProviderId 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/SocialIdentityProvider' application/scim+json: schema: $ref: '#/components/schemas/SocialIdentityProvider' '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 a Social Identity Provider operationId: PatchSocialIdentityProvider 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: ID of the resource in: path name: socialIdentityProviderId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SocialIdentityProvider' application/scim+json: schema: $ref: '#/components/schemas/SocialIdentityProvider' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the SocialIdentityProvider with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a Social Identity Provider operationId: PutSocialIdentityProvider 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: ID of the resource in: path name: socialIdentityProviderId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/SocialIdentityProvider' application/scim+json: schema: $ref: '#/components/schemas/SocialIdentityProvider' '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' '412': description: Preconditions in clients headers are not met by the server 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/SocialIdentityProvider' application/json: schema: $ref: '#/components/schemas/SocialIdentityProvider' description: "Replace the current instance of SocialIdentityProvider with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/UserAttributesSettings: get: description: Search User Schema Attribute Settings operationId: ListUserAttributesSettings 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/UserAttributesSettings' application/scim+json: schema: $ref: '#/components/schemas/UserAttributesSettings' '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 x-related-resource: '#/definitions/UserAttributesSetting' /admin/v1/UserAttributesSettings/.search: post: description: Search User Schema Attribute Settings Using POST operationId: SearchUserAttributesSettings 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/UserAttributesSettings' application/scim+json: schema: $ref: '#/components/schemas/UserAttributesSettings' '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 x-related-resource: '#/definitions/UserAttributesSetting' requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/UserAttributesSettingsSearchRequest' application/json: schema: $ref: '#/components/schemas/UserAttributesSettingsSearchRequest' description: Parameters for searching UserAttributesSettings /admin/v1/UserAttributesSettings/{userAttributesSettingId}: get: description: Get User Schema Attribute Settings operationId: GetUserAttributesSetting 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: userAttributesSettingId 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/UserAttributesSetting' application/scim+json: schema: $ref: '#/components/schemas/UserAttributesSetting' '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 User Schema Attribute Settings operationId: PatchUserAttributesSetting 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: userAttributesSettingId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/UserAttributesSetting' application/scim+json: schema: $ref: '#/components/schemas/UserAttributesSetting' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the UserAttributesSettings with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/UserCapabilitiesChanger/{userCapabilitiesChangerId}: put: description: Change a user's capabilities. operationId: PutUserCapabilitiesChanger 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: ID of the resource in: path name: userCapabilitiesChangerId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/UserCapabilitiesChanger' application/scim+json: schema: $ref: '#/components/schemas/UserCapabilitiesChanger' '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' '412': description: Preconditions in clients headers are not met by the server 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/UserCapabilitiesChanger' application/json: schema: $ref: '#/components/schemas/UserCapabilitiesChanger' description: "Replace the current instance of UserCapabilitiesChanger with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/UserDbCredentials: get: description: Search for a user's database (DB) credentials. operationId: ListUserDbCredentials 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/UserDbCredentials' application/scim+json: schema: $ref: '#/components/schemas/UserDbCredentials' '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 post: description: Create a user's database (DB) credentials. operationId: CreateUserDbCredential 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/UserDbCredential' application/scim+json: schema: $ref: '#/components/schemas/UserDbCredential' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/UserDbCredential' application/json: schema: $ref: '#/components/schemas/UserDbCredential' description: "UserDbCredentials schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/UserDbCredentials/.search: post: description: Search for a user's database (DB) credentials using POST. operationId: SearchUserDbCredentials 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/UserDbCredentials' application/scim+json: schema: $ref: '#/components/schemas/UserDbCredentials' '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/UserDbCredentialsSearchRequest' application/json: schema: $ref: '#/components/schemas/UserDbCredentialsSearchRequest' description: Parameters for searching UserDbCredentials /admin/v1/UserDbCredentials/{userDbCredentialId}: delete: description: Delete a user's database (DB) credentials. operationId: DeleteUserDbCredential 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: userDbCredentialId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/UserDbCredential' get: description: Get a user's database (DB) credentials. operationId: GetUserDbCredential 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: userDbCredentialId 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/UserDbCredential' application/scim+json: schema: $ref: '#/components/schemas/UserDbCredential' '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/UserPasswordChanger/{userPasswordChangerId}: put: description: Change a user's password to a known value. operationId: PutUserPasswordChanger 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: ID of the resource in: path name: userPasswordChangerId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/UserPasswordChanger' application/scim+json: schema: $ref: '#/components/schemas/UserPasswordChanger' '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' '412': description: Preconditions in clients headers are not met by the server 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/UserPasswordChanger' application/json: schema: $ref: '#/components/schemas/UserPasswordChanger' description: "Replace the current instance of UserPasswordChanger with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/UserPasswordResetter/{userPasswordResetterId}: put: description: Reset a user's password to a randomly-generated value. operationId: PutUserPasswordResetter 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: ID of the resource in: path name: userPasswordResetterId 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': description: 'The request was successful. ' headers: etag: description: For optimistic concurrency control. See `if-match`. 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/UserPasswordResetter' application/scim+json: schema: $ref: '#/components/schemas/UserPasswordResetter' '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' '412': description: Preconditions in clients headers are not met by the server 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/UserPasswordResetter' application/json: schema: $ref: '#/components/schemas/UserPasswordResetter' description: "Replace the current instance of UserPasswordResetter with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/UserStatusChanger/{userStatusChangerId}: put: description: Change a user's status. operationId: PutUserStatusChanger 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: userStatusChangerId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/UserStatusChanger' application/scim+json: schema: $ref: '#/components/schemas/UserStatusChanger' '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' '412': description: Preconditions in clients headers are not met by the server 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/UserStatusChanger' application/json: schema: $ref: '#/components/schemas/UserStatusChanger' description: "Replace the current instance of UserStatusChanger with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Users: get: description: Search for users. operationId: ListUsers 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/Users' application/scim+json: schema: $ref: '#/components/schemas/Users' '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 post: description: Create a user. operationId: CreateUser 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: 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: '201': description: The request was successful. We created a new resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/User' application/scim+json: schema: $ref: '#/components/schemas/User' '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 requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/User' application/json: schema: $ref: '#/components/schemas/User' description: "User schema.\n\nBefore you specify an attribute-value in a request to create a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" /admin/v1/Users/.search: post: description: Search for users using POST. operationId: SearchUsers 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/Users' application/scim+json: schema: $ref: '#/components/schemas/Users' '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/UserSearchRequest' application/json: schema: $ref: '#/components/schemas/UserSearchRequest' description: Parameters for searching Users /admin/v1/Users/{userId}: delete: description: Delete a user. operationId: DeleteUser 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: To force delete the resource and all its references (if any). in: query name: forceDelete required: false x-default-description: 'null' schema: type: boolean - description: ID of the resource in: path name: userId 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: '204': description: Deletion 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 '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' '412': description: Preconditions in clients headers are not met by the server 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 x-related-resource: '#/definitions/User' get: description: Get a user. operationId: GetUser 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: userId 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/User' application/scim+json: schema: $ref: '#/components/schemas/User' '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 a user. operationId: PatchUser 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: userId 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': description: The request was successful. We updated the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/User' application/scim+json: schema: $ref: '#/components/schemas/User' '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' '412': description: Preconditions in clients headers are not met by the server 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/PatchOp' application/json: schema: $ref: '#/components/schemas/PatchOp' description: "Update the User with SCIM Patch schema.\n\nBefore you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" put: description: Replace a user. operationId: PutUser 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: userId 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': description: The request was successful. We replaced the resource. headers: etag: description: For optimistic concurrency control. See `if-match`. 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/User' application/scim+json: schema: $ref: '#/components/schemas/User' '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' '412': description: Preconditions in clients headers are not met by the server 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/User' application/json: schema: $ref: '#/components/schemas/User' description: "Replace the current instance of User with provided payload.\n\nBefore you specify an attribute-value in a request to replace a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute.\n- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*:\n - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*.\n - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*.\n - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.\n\nAlso, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below:\n- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*:\n - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*.\n - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*.\n - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.\n" components: schemas: AccountMgmtInfoSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object SmtpCredential: description: User's smtp credential properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "User credential expires on\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "User credential status\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' user: $ref: '#/components/schemas/SmtpCredentialUser' userName: description: "User name\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readOnly\n - required: true\n - returned: default" maxLength: 4000 type: string required: - schemas - userName type: object AppEditableAttributes: description: App attributes editable by subject properties: name: description: "Name of the attribute. The attribute name will be qualified by schema name if any extension schema defines the attribute. The attribute name will not be qualified by schema name if the base schema defines the attribute.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - name type: object MeIms: description: User's instant messaging addresses properties: display: description: "A human-readable name, primarily used for display purposes\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string primary: description: "A Boolean value that indicates the 'primary' or preferred attribute value for this attribute--for example, the preferred messenger or primary messenger. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label that indicates the attribute's function--for example, 'aim', 'gtalk', or 'mobile'\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - aim - gtalk - icq - xmpp - msn - skype - qq - yahoo type: string value: description: "User's instant messaging address\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string required: - value - type type: object MePhoneNumbers: description: Phone numbers properties: display: description: "A human-readable name, primarily used for display purposes. READ ONLY\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string primary: description: "A Boolean value that indicates the 'primary' or preferred attribute value for this attribute--for example, the preferred phone number or primary phone number. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label that indicates the attribute's function- for example, 'work', 'home', or 'mobile'\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - work - home - mobile - fax - pager - other - recovery type: string value: description: "User's phone number\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string verified: description: "A Boolean value that indicates if the phone number is verified.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - value - type type: object CloudGateExtMappings: description: A list of Cloud Gate Mappings that map Apps to this Cloud Gate properties: $ref: description: "URI of the App being mapped to\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string appId: description: "The ID of the App being mapped to\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string mappingId: description: "The id of the Cloud Gate Mapping\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The name (Client ID) of the App being mapped to\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 128 type: string nginxSettings: description: "More NGINX Settings. JSON encoded key value pairs similar to WTP encoding\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string policyName: description: "The Web Tier policy name used for the App that is mapped to this Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string proxyPass: description: "NGINX ProxyPass entry for this Mapping\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string resourcePrefix: description: "Resource prefix for this mapping. This will be used to define the location block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string serverId: description: "Server Instance for the Mapping. This is one of the server IDs(server blocks) from the associated Cloud Gate list\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string upstreamServerGroupId: description: "Upstream server group instance for the Mapping. This is one of the upstream server group IDs(upstream blocks) from the associated Cloud Gate list\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string value: description: "The id of the App being mapped to\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - resourcePrefix - serverId type: object ExtensionPosixGroup: description: POSIX Group extension properties: gidNumber: description: "Integer uniquely identifying a group in a POSIX administrative domain\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: integer\n - uniqueness: server" type: integer type: object PasswordPolicyConfiguredPasswordPolicyRules: description: List of password policy rules that have values set. This map of stringKey:stringValue pairs can be used to aid users while setting/resetting password properties: key: description: "The specific password policy rule\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "User-friendly text that describes a specific password policy rule\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - key - value type: object AppGrants: description: Grants assigned to the app properties: $ref: description: "Grant URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string grantMechanism: description: "Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.\nA customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR':\n - 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User.\n - 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group.\n - 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - IMPORT_APPROLE_MEMBERS - ADMINISTRATOR_TO_USER - ADMINISTRATOR_TO_GROUP - SERVICE_MANAGER_TO_USER - ADMINISTRATOR_TO_APP - SERVICE_MANAGER_TO_APP - OPC_INFRA_TO_APP - GROUP_MEMBERSHIP type: string granteeId: description: "Grantee identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string granteeType: description: "Grantee resource type. Allowed values are User and Group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - Group type: string value: description: "Grant identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object MySupportAccount: description: Support Provider Account properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string provider: description: "User Support Account Provider\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - idcsSearchable: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - MOS maxLength: 16 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string token: description: "User Support Account Token\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - required: true\n - returned: never\n - type: string\n - uniqueness: none" maxLength: 5000 type: string user: $ref: '#/components/schemas/MySupportAccountUser' userId: description: "User Support User Id\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 320 type: string required: - schemas - token type: object GrantSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MyTrustedUserAgent: description: "This schema defines the attributes of Trusted User Agents owned by users. Multi-Factor Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests.\n For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, one of several executing on a particular mobile device). \n A User Agent is trusted once the Multi-Factor Authentication has verified it in some way." properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiryTime: description: "Validation period of the trust token.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array lastUsedOn: description: "Indicates when this token was used lastime.\n\n**Added In:** 2111190457\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string location: description: "Trust token issued geo-location.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 500 type: string meta: $ref: '#/components/schemas/meta' name: description: "The name of the User Agent that the user wants the system to trust and to use in Multi-Factor Authentication.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - idcsRequiresWriteForAccessFlows: true\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 500 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string platform: description: "User agent platform for which the trust token has been issued.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 500 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string tokenType: description: "The token type being created. This token is used as trusted and kmsi token.\n\n**Added In:** 2111190457\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - KMSI - TRUSTED maxLength: 100 type: string trustToken: description: "Trust token for the user agent. This is a random string value that will be updated whenever a token that has been issued is verified successfully.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 1000 type: string trustedFactors: description: "Trusted 2FA Factors\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [type]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/MyTrustedUserAgentTrustedFactors' type: array user: $ref: '#/components/schemas/MyTrustedUserAgentUser' required: - schemas - name - trustToken - user type: object UserIms: description: User's instant messaging addresses properties: display: description: "A human-readable name, primarily used for display purposes\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string primary: description: "A Boolean value that indicates the 'primary' or preferred attribute value for this attribute--for example, the preferred messenger or primary messenger. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label that indicates the attribute's function--for example, 'aim', 'gtalk', or 'mobile'\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - aim - gtalk - icq - xmpp - msn - skype - qq - yahoo type: string value: description: "User's instant messaging address\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string required: - value - type type: object AppDomainApp: description: "Description:\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none\n" properties: $ref: description: "DB Domain App URI\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "DB Domain App display name\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string value: description: "DB Domain App identifier\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object MyRequestRequestor: description: "Requesting User\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "User URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "User identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeName: requestor_id\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object MyDevices: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyDevice' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object PolicyPolicyType: description: "PolicyType on which the policy is based\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "PolicyType URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "PolicyType identifier.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object MyAuthenticationFactorsRemover: description: This schema defines the attributes of Authentication Factors Remover call. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string token: description: "Specifies the token to be removed\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: request\n - uniqueness: none\n - idcsSearchable: false" type: string type: description: "Specifies the type of factors to remove. Either MFA factors or AccountRecovery factors or All factors\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" enum: - KMSI - MFA - ACCOUNTRECOVERY - ALL type: string user: $ref: '#/components/schemas/MyAuthenticationFactorsRemoverUser' required: - schemas - user type: object MySupportAccountUser: description: "User linked to Support Account\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this Support Account\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "User name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "User's ocid\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "User's id\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object AppGroupAssertionAttributes: description: "Each value of this attribute describes an attribute of Group that will be sent in a Security Assertion Markup Language (SAML) assertion.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: condition: description: "Indicates the filter types that are supported for the Group assertion attributes.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string format: description: "Indicates the format of the assertion attribute.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string groupName: description: "Indicates the group name that are supported for the group assertion attributes.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string required: - name type: object UserExtRiskScores: description: "The risk score pertaining to the user.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "Risk Provider Profile URI: URI that corresponds to risk source identifier.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: reference\n - uniqueness: none" type: string lastUpdateTimestamp: description: "Last update timestamp for the risk score\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: dateTime\n - uniqueness: none" type: string riskLevel: description: "Risk Level\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" enum: - LOW - MEDIUM - HIGH type: string score: description: "Risk Score value\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: integer\n - uniqueness: none\n - idcsMaxValue: 100\n - idcsMinValue: 0" type: integer source: description: "Risk Provider Profile Source\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string status: description: "Risk Provider Profile status\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "Risk Provider Profile: Identifier for the provider service from which the risk score was received.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value - score - riskLevel - lastUpdateTimestamp type: object MeRoles: description: A list of roles for the User that collectively represent who the User is; e.g., 'Student', 'Faculty'. properties: display: description: "A human readable name, primarily used for display purposes.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label indicating the attribute's function.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The value of a role.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string required: - value - type type: object AppExtensionOpcServiceApp: description: This extension defines attributes specific to Apps that represent instances of an Oracle Public Cloud (OPC) service. properties: currentFederationMode: description: "Current Federation Mode\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string" enum: - None - AppAsServiceProvider - AppAsIdentityProvider type: string currentSynchronizationMode: description: "Current Synchronization Mode\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string" enum: - None - AppAsTarget - AppAsSource type: string enablingNextFedSyncModes: description: "If true, indicates that enablement is in progress started but not completed\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean" type: boolean nextFederationMode: description: "Next Federation Mode\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string" enum: - None - AppAsServiceProvider - AppAsIdentityProvider type: string nextSynchronizationMode: description: "Next Synchronization Mode\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string" enum: - None - AppAsTarget - AppAsSource type: string region: description: "This value identifies the OPC region in which the service is running.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 40 type: string serviceInstanceIdentifier: description: "This value specifies the unique identifier assigned to an instance of an Oracle Public Cloud service app.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: server" type: string type: object SettingsDefaultCompanyNames: description: Default name of the Company in different locales properties: locale: description: "Locale\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(companyNames.locale)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Company name\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" maxLength: 50 type: string required: - value - locale type: object AccountMgmtInfoApp: description: "Application on which the account is based\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Application URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string active: description: "If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App and only administrative operations can be performed.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean appIcon: description: "Application icon.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 75000 minLength: 1 type: string appThumbnail: description: "Application thumbnail.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 45000 minLength: 1 type: string audience: description: "The base URI for all of the scopes defined in this App. The value of 'audience' is combined with the 'value' of each scope to form an 'fqs' or fully qualified scope.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string description: description: "Application description\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string display: description: "Application display name\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string isAliasApp: description: "If true, this App is an AliasApp and it cannot be granted to an end user directly\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean isAuthoritative: description: "If true, sync from the managed app will be performed as authoritative sync.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean isLoginTarget: description: "If true, this App allows runtime services to log end users in to this App automatically\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean isManagedApp: description: "If true, indicates that access to this App requires an account. That is, in order to log in to the App, a User must use an application-specific identity that is maintained in the remote identity-repository of that App.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean isOAuthResource: description: "If true, indicates that this application acts as an OAuth Resource.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean isOPCService: description: "If true, this application is an Oracle Public Cloud service-instance.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean isUnmanagedApp: description: "If true, indicates that this application accepts an Oracle Identity Cloud Service user as a login-identity (does not require an account) and relies on authorization of the user's memberships in AppRoles\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean loginMechanism: description: "The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use the Security Assertion Markup Language protocol.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string meterAsOPCService: description: "If true, customer is not billed for runtime operations of the app.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean serviceTypeURN: description: "This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string showInMyApps: description: "If true, this App will be displayed in the MyApps page of each end-user who has access to the App.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean value: description: "Application identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object MyUserDbCredentialsUser: description: "The user linked to the database credential.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The username.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's identifier.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object UserExtSupportAccounts: description: "A list of Support Accounts corresponding to user.\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding Support Account resource to which the user belongs\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ocid: description: "The OCID of the user's support account.\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string provider: description: "User Support Account Provider\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string userId: description: "User Support User Id\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "The identifier of the User's support Account.\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object MyCustomerSecretKeyUser: description: "User linked to customer secret key\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The user's name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object CloudGateMapping: description: Resource representing a Cloud Gate mapping properties: cloudGate: $ref: '#/components/schemas/CloudGateMappingCloudGate' compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Brief description for this Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string gatewayApp: $ref: '#/components/schemas/CloudGateMappingGatewayApp' id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isOPCService: description: "Indicates whether this resource was created by OPC\n\n**Added In:** 19.3.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: boolean\n - uniqueness: none" type: boolean meta: $ref: '#/components/schemas/meta' nginxSettings: description: "More NGINX Settings. JSON encoded key value pairs similar to WTP encoding\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string policyName: description: "The Web Tier policy name used for the App that is mapped to the owning Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string proxyPass: description: "NGINX ProxyPass entry for this Mapping\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string resourcePrefix: description: "Resource prefix for this mapping. This will be used to define the location block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array server: $ref: '#/components/schemas/CloudGateMappingServer' tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string upstreamServerGroup: $ref: '#/components/schemas/CloudGateMappingUpstreamServerGroup' required: - schemas - resourcePrefix - policyName - server - gatewayApp - cloudGate type: object IdentityProviderRelayIdpParamMappings: description: "Relay Param variable for Social IDP\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [relayParamKey]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: relayParamKey: description: "Key or name of the relayParam.\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string relayParamValue: description: "Value of the relayParam (if defined)\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string required: - relayParamKey type: object Condition: description: Condition resource. A unit that captures a condition. properties: attributeName: description: "AttributeName - RHS of condition\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string attributeValue: description: "attributeValue - RHS of condition\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Condition Description\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string evaluateConditionIf: description: "Evaluate the condition if this expression returns true, else skip condition evaluation\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' name: description: "Condition name\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 256 minLength: 1 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string operator: description: '**SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none Operator in the condition. It support all SCIM operators like eq, gt, lt, le, sw etc ' enum: - eq - ne - co - coany - sw - ew - gt - ge - lt - le - in - nin type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Tag Key, mapsTo:tags.key], [columnHeaderName:Tag Value, mapsTo:tags.value]]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:ociconsolesignonpolicyconsent:Policy: $ref: '#/components/schemas/ConditionExtensionOciconsolesignonpolicyconsentPolicy' required: - schemas - name - attributeName - operator - attributeValue type: object AppExtensionMulticloudServiceAppApp: description: This extension defines attributes specific to Apps that represent instances of Multicloud Service App properties: multicloudPlatformUrl: description: "The multicloud platform service URL which the application will invoke for runtime operations such as AWSCredentials api invocation\n\n**Added In:** 2301202328\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string multicloudServiceType: description: "Specifies the service type for which the application is configured for multicloud integration. For applicable external service types, app will invoke multicloud service for runtime operations\n\n**Added In:** 2301202328\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: request\n - type: string\n - uniqueness: none" enum: - AWSCognito maxLength: 100 minLength: 1 type: string required: - multicloudServiceType type: object GroupExtPasswordPolicy: description: "Password Policy associated with this Group.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "PasswordPolicy URI\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string name: description: "PasswordPolicy Name\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string priority: description: "PasswordPolicy priority\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer value: description: "The ID of the PasswordPolicy.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value type: object Me: description: User Account properties: active: description: "User status\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Active\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Active]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean addresses: description: "A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [type]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Address Street, deprecatedColumnHeaderName:Work Street Address, mapsTo:addresses[work].streetAddress], [columnHeaderName:Work Address Locality, deprecatedColumnHeaderName:Work City, mapsTo:addresses[work].locality], [columnHeaderName:Work Address Region, deprecatedColumnHeaderName:Work State, mapsTo:addresses[work].region], [columnHeaderName:Work Address Postal Code, deprecatedColumnHeaderName:Work Postal Code, mapsTo:addresses[work].postalCode], [columnHeaderName:Work Address Country, deprecatedColumnHeaderName:Work Country, mapsTo:addresses[work].country], [columnHeaderName:Work Address Formatted, mapsTo:addresses[work].formatted], [columnHeaderName:Home Address Formatted, mapsTo:addresses[home].formatted], [columnHeaderName:Other Address Formatted, mapsTo:addresses[other].formatted], [columnHeaderName:Home Address Street, mapsTo:addresses[home].streetAddress], [columnHeaderName:Other Address Street, mapsTo:addresses[other].streetAddress], [columnHeaderName:Home Address Locality, mapsTo:addresses[home].locality], [columnHeaderName:Other Address Locality, mapsTo:addresses[other].locality], [columnHeaderName:Home Address Region, mapsTo:addresses[home].region], [columnHeaderName:Other Address Region, mapsTo:addresses[other].region], [columnHeaderName:Home Address Country, mapsTo:addresses[home].country], [columnHeaderName:Other Address Country, mapsTo:addresses[other].country], [columnHeaderName:Home Address Postal Code, mapsTo:addresses[home].postalCode], [columnHeaderName:Other Address Postal Code, mapsTo:addresses[other].postalCode], [columnHeaderName:Primary Address Type, mapsTo:addresses[$(type)].primary]]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/addresses' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description of the user\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsPii: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 400 minLength: 1 type: string displayName: description: "Display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Display Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Display Name]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 382 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string emails: description: "A complex attribute representing emails\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Email, mapsTo:emails[work].value], [columnHeaderName:Home Email, mapsTo:emails[home].value], [columnHeaderName:Primary Email Type, mapsTo:emails[$(type)].primary], [columnHeaderName:Other Email, mapsTo:emails[other].value], [columnHeaderName:Recovery Email, mapsTo:emails[recovery].value], [columnHeaderName:Work Email Verified, mapsTo:emails[work].verified], [columnHeaderName:Home Email Verified, mapsTo:emails[home].verified], [columnHeaderName:Other Email Verified, mapsTo:emails[other].verified], [columnHeaderName:Recovery Email Verified, mapsTo:emails[recovery].verified]]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MeEmails' type: array entitlements: description: "A list of entitlements for the User that represent a thing the User has.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MeEntitlements' type: array externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeNameMappings: [[columnHeaderName:External Id]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string groups: description: "A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MeGroups' type: array id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array ims: description: "User's instant messaging addresses\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MeIms' type: array locale: description: "Used to indicate the User's default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Locale\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Locale]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string meta: $ref: '#/components/schemas/meta' name: $ref: '#/components/schemas/MeName' nickName: description: "Nick name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Nick Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Nick Name]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 5 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string password: description: "Password attribute. Max length for password is controlled via Password Policy.\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Password\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Password]]\n - idcsPii: true\n - idcsSearchable: false\n - idcsSensitive: hash\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" maxLength: 500 minLength: 1 type: string phoneNumbers: description: "Phone numbers\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Phone, mapsTo:phoneNumbers[work].value], [columnHeaderName:Mobile No, mapsTo:phoneNumbers[mobile].value], [columnHeaderName:Home Phone, mapsTo:phoneNumbers[home].value], [columnHeaderName:Fax, mapsTo:phoneNumbers[fax].value], [columnHeaderName:Pager, mapsTo:phoneNumbers[pager].value], [columnHeaderName:Other Phone, mapsTo:phoneNumbers[other].value], [columnHeaderName:Recovery Phone, mapsTo:phoneNumbers[recovery].value], [columnHeaderName:Primary Phone Type, mapsTo:phoneNumbers[$(type)].primary]]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MePhoneNumbers' type: array photos: description: "URLs of photos for the User\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MePhotos' type: array preferredLanguage: description: "User's preferred written or spoken language used for localized user interfaces\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Preferred Language\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Preferred Language]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string profileUrl: description: "A fully-qualified URL to a page representing the User's online profile\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Profile URL\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Profile Url]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" maxLength: 2000 minLength: 1 type: string roles: description: "A list of roles for the User that collectively represent who the User is; e.g., 'Student', 'Faculty'.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MeRoles' type: array schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string timezone: description: "User's timezone\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"timezones\" and attrValues.value eq \"$(timezone)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsCsvAttributeName: TimeZone\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Time Zone, deprecatedColumnHeaderName:TimeZone]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string title: description: "Title\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Title\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Title]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 1 type: string urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: $ref: '#/components/schemas/ExtensionEnterprise20User' urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags: $ref: '#/components/schemas/ExtensionOCITags' urn:ietf:params:scim:schemas:oracle:idcs:extension:capabilities:User: $ref: '#/components/schemas/ExtensionCapabilitiesUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:dbCredentials:User: $ref: '#/components/schemas/ExtensionDbCredentialsUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:me:User: $ref: '#/components/schemas/ExtensionMeUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:mfa:User: $ref: '#/components/schemas/ExtensionMfaUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordState:User: $ref: '#/components/schemas/ExtensionPasswordStateUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:User: $ref: '#/components/schemas/ExtensionPosixUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:securityQuestions:User: $ref: '#/components/schemas/ExtensionSecurityQuestionsUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:selfRegistration:User: $ref: '#/components/schemas/ExtensionSelfRegistrationUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:termsOfUse:User: $ref: '#/components/schemas/ExtensionTermsOfUseUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User: $ref: '#/components/schemas/ExtensionUserUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:userCredentials:User: $ref: '#/components/schemas/ExtensionUserCredentialsUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:userState:User: $ref: '#/components/schemas/ExtensionUserStateUser' userName: description: "User name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: User ID\n - idcsCsvAttributeNameMappings: [[columnHeaderName:User Name, deprecatedColumnHeaderName:User ID]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 256 minLength: 1 type: string userType: description: "Used to identify the organization-to-user relationship\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: User Type\n - idcsCsvAttributeNameMappings: [[columnHeaderName:User Type]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Contractor - Employee - Intern - Temp - External - Service - Generic type: string x509Certificates: description: "A list of certificates issued to the User.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MeX509Certificates' type: array required: - schemas - userName type: object UserExtPasswordVerifiers: description: "Password Verifiers for DB User.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [type]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: type: description: "Type of database password verifier (for example, MR-SHA512 or SSHA).\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Hash value of database password verifier.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - type - value type: object UserGroups: description: A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated properties: $ref: description: "The URI of the corresponding Group resource to which the user belongs\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string dateAdded: description: "Date when the member is Added to the group\n\n**Added In:** 2105200541\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. READ-ONLY.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string membershipOcid: description: "The membership OCID.\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string nonUniqueDisplay: description: "A human readable name for Group as defined by the Service Consumer. READ-ONLY.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the User's group.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "A label indicating the attribute's function; e.g., 'direct' or 'indirect'.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" enum: - direct - indirect type: string value: description: "The identifier of the User's group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value type: object KmsiSetting: description: Kmsi Settings schema properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array kmsiFeatureEnabled: description: "Identifier represents KMSI feature is enabled or not.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean kmsiPromptEnabled: description: "Identifier represents KMSI to be prompted to user or not.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean lastEnabledOn: description: "Timestamp of when the KmsiSettings was enabled last time.\n\n**Added In:** 2203071610\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string lastUsedValidityInDays: description: "Identifier represents duration in days within which kmsi token must be used.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - idcsMaxValue: 365\n - idcsMinValue: 1\n - uniqueness: none" type: integer maxAllowedSessions: description: "Identifier represents maximum KMSI sessions allowed in the system.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - idcsMaxValue: 10\n - idcsMinValue: 1\n - uniqueness: none" type: integer meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string tokenValidityInDays: description: "Identifier represents validity duration in days.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - idcsMaxValue: 1100\n - idcsMinValue: 1\n - uniqueness: none" type: integer touPromptDisabled: description: "Identifier represents whether user is prompted for ToU or not.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - schemas type: object Rule: description: Rule resource. A unit that has a condition which on evaluation with input returns defined values. properties: active: description: "If true, rule is active\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string condition: description: "SCIM filters\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string conditionGroup: $ref: '#/components/schemas/RuleConditionGroup' deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Rule Description\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array locked: description: "Shows if the rule is locked\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean meta: $ref: '#/components/schemas/meta' name: description: "Rule name\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string policyType: $ref: '#/components/schemas/RulePolicyType' return: description: "The return values are the then portion of a Rule\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/RuleReturn' type: array ruleGroovy: description: "The Groovy script that is run instead of the rule, if policy type allows the rule to be a Groovy script.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Tag Key, mapsTo:tags.key], [columnHeaderName:Tag Value, mapsTo:tags.value]]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:ociconsolesignonpolicyconsent:Policy: $ref: '#/components/schemas/RuleExtensionOciconsolesignonpolicyconsentPolicy' required: - schemas - name - condition - policyType - return type: object Operations: description: Each patch operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace". See [Section 3.5.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.5.2) for details. properties: op: description: Defines the operation to be performed for this Patch. If op=remove, value is not required. enum: - ADD - REMOVE - REPLACE type: string path: description: String containing an attribute path describing the target of the operation. The "path" attribute is OPTIONAL for "add" and "replace" and is REQUIRED for "remove" operations. See [Section 3.5.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.5.2) for details type: string value: description: 'The value could be either a simple value attribute e.g. string or number OR complex like map of the attributes to be added or replaced OR multivalues complex attributes.q1 ' type: object required: - op - path type: object Conditions: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/Condition' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object CloudGateMappingCloudGate: description: "Reference to owning Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the OAuth app for this Cloud Gate.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "The id of the owning Cloud Gate.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object CloudGates: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/CloudGate' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object OAuth2ClientCredentialScopes: description: Scopes properties: audience: description: "Audience\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: true\n - returned: default" maxLength: 200 type: string scope: description: "Scope\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsScimCompliant: false\n - type: string\n - mutability: readWrite\n - multiValued: false\n - required: true\n - returned: default" maxLength: 100 type: string required: - audience - scope type: object AppObjectClasses: description: "Object classes\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Object class URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Object class display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string isAccountObjectClass: description: "If true, the object class represents an account. The isAccountObjectClass attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean resourceType: description: "Object class resource type\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsDefaultValue: AccountObjectClass\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - AccountObjectClass - ManagedObjectClass type: string value: description: "Object class template identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object ExtensionMessagesError: description: "Extension schema for error messages providing more details with the exception status. \nReturns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked." properties: additionalData: description: Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format. type: object messageId: description: Internal error keyword pointing to the exception status message. REQUIRED. type: string type: object AppAsOPCService: description: "OPCService facet of the application.\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "URI of the OPCService facet.\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Identifier of the OPCService facet.\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object ExtensionSelfChangeUser: description: Controls whether a user can update themselves or not via User related APIs properties: allowSelfChange: description: "If true, allows requesting user to update themselves. If false, requesting user can't update themself (default).\n\n**Added In:** 2205182039\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean type: object AppOutboundAssertionAttributes: description: "Use to construct the outgoing SAML attributes\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Mapped Attribute URI\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string direction: description: "Mapped Attribute Direction\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Mapped Attribute identifier\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object tags: description: A list of tags on this resource. properties: key: description: "Key or name of the tag.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string value: description: "Value of the tag.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string required: - key - value type: object AppUserAssertionAttributes: description: "Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: format: description: "Indicates the format of the assertion attribute.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string userStoreAttributeName: description: "This attribute specifies which user attribute should be used to create the value of the SAML assertion attribute. The userstore attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema.
Note: Attributes from extensions to the Core User schema are not supported in v1.0.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 512 type: string required: - name - userStoreAttributeName type: object SettingsDefaultLoginTexts: description: Default Login text in different locales properties: locale: description: "Locale\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(loginTexts.locale)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Login text\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - idcsSanitize: true" maxLength: 250 type: string required: - value - locale type: object ConditionSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object UserExtRealmUsers: description: "A list of kerberos realm users for an Oracle Identity Cloud Service User\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding KerberosRealmUser resource associated with the Oracle Identity Cloud Service User.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string principalName: description: "Principal Name of the KerberosRealmUser associated with the Oracle Identity Cloud Service User.\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string realmName: description: "Realm Name for the KerberosRealmUser associated with the Oracle Identity Cloud Service User.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "id of the KerberosRealmUser associated with the Oracle Identity Cloud Service User.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string required: - value type: object CloudGateMappingGatewayApp: description: "Reference to gateway application protected by this Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI to the gateway application protected by this Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string name: description: "The name (Client ID) of the gateway application protected by this Cloud Gate.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 2 type: string value: description: "The id of the gateway application protected by this Cloud Gate.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - name - value type: object MeEntitlements: description: A list of entitlements for the User that represent a thing the User has. properties: display: description: "A human readable name, primarily used for display purposes.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label indicating the attribute's function.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The value of an entitlement.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string required: - value - type type: object MyRequestApprovalDetails: description: Approvals created for this request. properties: approvalType: description: "Approval Type (Escalation or Regular)\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - returned: default\n - type: string\n - uniqueness: none\n - mutability: readOnly" type: string approverDisplayName: description: "Approver display name\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - returned: default\n - type: string\n - uniqueness: none\n - mutability: readOnly" type: string approverId: description: "Approver Id\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - returned: default\n - type: string\n - uniqueness: none\n - mutability: readOnly" type: string justification: description: "Approval Justification\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - multiValued: false\n - idcsSearchable: false\n - returned: default\n - type: string\n - uniqueness: none\n - mutability: readOnly" type: string order: description: "Approval Order\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - returned: default\n - type: integer\n - uniqueness: none\n - mutability: readOnly" type: integer status: description: "Approval Status\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - returned: default\n - type: string\n - uniqueness: none\n - mutability: readOnly" type: string timeUpdated: description: "Approval Update Time\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - multiValued: false\n - idcsSearchable: false\n - returned: default\n - type: dateTime\n - uniqueness: none\n - mutability: readOnly" type: string type: object PasswordPolicyGroups: description: A list of groups that the password policy belongs to. properties: $ref: description: "The URI of the corresponding Group resource to which the password policy belongs\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Group Display Name\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The identifier of the group.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object ResourceTypeSchemaAttributeSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object UserExtLocked: description: "A complex attribute that indicates an account is locked (blocking any new sessions).\n\n**SCIM++ Properties:**\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Locked, mapsTo:locked.on], [columnHeaderName:Locked Reason, mapsTo:locked.reason], [columnHeaderName:Locked Date, mapsTo:locked.lockDate]]\n - idcsSearchable: false\n - idcsAllowUpdatesInReadOnlyMode: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: expired: description: "Indicates whether the user password is expired. If this value is false, password expiry is still evaluated during user login.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean lockDate: description: "The date and time that the current resource was locked.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string 'on': description: "Indicates that the account is locked.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean reason: description: "Indicates the reason for locking the account. Valid values are: 0 - failed password login attempts, 1 - admin lock, 2 - failed reset password attempts, 3 - failed MFA login attempts, 4 - failed MFA login attempts for federated user, 5 - failed Database login attempts\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer type: object UserExtGrants: description: "Grants to this User. Each value of this attribute refers to a Grant to this User of some App (and optionally of some entitlement). Therefore, this attribute is a convenience that allows one to see on each User all of the Grants to that User.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of this Grant to this User.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string appId: description: "The ID of the App in this Grant.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string grantMechanism: description: "Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.\nA customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR':\n - 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User.\n - 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group.\n - 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - IMPORT_APPROLE_MEMBERS - ADMINISTRATOR_TO_USER - ADMINISTRATOR_TO_GROUP - SERVICE_MANAGER_TO_USER - ADMINISTRATOR_TO_APP - SERVICE_MANAGER_TO_APP - OPC_INFRA_TO_APP - GROUP_MEMBERSHIP type: string grantorId: description: "Grantor identifier\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The ID of this Grant to this User.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object UserAttributesSettingsSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array required: - schemas type: object AuthenticationFactorSettingsIdentityStoreSettings: description: "Settings related to the use of a user's profile details from the identity store\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: mobileNumberEnabled: description: "If true, indicates that Multi-Factor Authentication should use the mobile number in the identity store\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean mobileNumberUpdateEnabled: description: "If true, indicates that the user can update the mobile number in the user's Multi-Factor Authentication profile\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: object CloudGateExtServers: description: A list of Server Blocks on this Cloud Gate properties: hostName: description: "Hostname for the Server block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string nginxSettings: description: "More nginx Settings. JSON encoded text block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string port: description: "Port for the Server Block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer serverId: description: "Server Name for the Server Block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ssl: description: "SSL flag for the Server Block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - hostName - port - ssl type: object SettingsImages: description: References to various images properties: display: description: "A human-readable name, primarily used for display purposes\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string type: description: "Indicates the image type\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" type: string value: description: "Image URI\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: reference" type: string required: - value - type type: object RulePolicyType: description: "PolicyType on which the policy is based\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "PolicyType URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "PolicyType identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object DynamicResourceGroupGrants: description: Grants assigned to group properties: $ref: description: "Grant URI\n\n**SCIM++ Properties:**\n - idcsAddedSinceVersion: 3\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string appId: description: "App identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsAddedSinceVersion: 3\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string grantMechanism: description: "Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.\nA customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR':\n - 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User.\n - 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group.\n - 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsAddedSinceVersion: 3\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - IMPORT_APPROLE_MEMBERS - ADMINISTRATOR_TO_DYNAMIC_RESOURCE_GROUP - ADMINISTRATOR_TO_USER - ADMINISTRATOR_TO_GROUP - SERVICE_MANAGER_TO_USER - ADMINISTRATOR_TO_APP - SERVICE_MANAGER_TO_APP - OPC_INFRA_TO_APP - GROUP_MEMBERSHIP type: string value: description: "Grant identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsAddedSinceVersion: 3\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object UserExtFactorIdentifier: description: "Factor Identifier ID\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the device resource\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Factor Identifier display name\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The identifier of the User's preferred device\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 42 minLength: 1 type: string required: - value type: object CustomerSecretKey: description: The user's customer secret key. properties: accessKey: description: "The access key.\n\n**SCIM++ Properties:**\n - caseExact: true\n - type: string\n - mutability: readOnly\n - required: false\n - returned: default" type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string displayName: description: "Display Name\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "When the user's credential expire.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "The user's credential status.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' user: $ref: '#/components/schemas/CustomerSecretKeyUser' required: - schemas type: object ApiKey: description: The user's API key. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**Added In:** 2101262133\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string fingerprint: description: "Fingerprint\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - type: string\n - mutability: readOnly\n - required: true\n - returned: default" maxLength: 4000 type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array key: description: "Key\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsPii: true\n - type: string\n - mutability: immutable\n - required: true\n - returned: default" maxLength: 4000 type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' user: $ref: '#/components/schemas/ApiKeyUser' required: - schemas - fingerprint - key type: object MyDevice: description: Device Resource. properties: additionalAttributes: description: "Device additional attributes\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/MyDeviceAdditionalAttributes' type: array appVersion: description: "Mobile Authenticator App Version\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 40 minLength: 1 type: string authenticationFactors: description: "Authentication Factors\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [type]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/MyDeviceAuthenticationFactors' type: array authenticationMethod: description: "Authentication method used in device. For FIDO, it will contain SECURITY_KEY/WINDOWS_HELLO etc\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 256 minLength: 1 type: string basePublicKey: description: "Device base public Key\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 4000 minLength: 1 type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string countryCode: description: "Country code of user's Phone Number\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 40 minLength: 1 type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean deviceType: description: "Device hardware name/model\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 40 minLength: 1 type: string deviceUUID: description: "Unique id sent from device\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 40 minLength: 1 type: string displayName: description: "Device friendly display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 256 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "Attribute added for replication log, it is not used by IDCS, just added as place holder\n\n**Added In:** 2111040242\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isAccRecEnabled: description: "Flag that indicates whether the device is enrolled for account recovery\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" type: boolean isCompliant: description: "Device Compliance Status\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean lastSyncTime: description: "Last Sync time for device\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string lastValidatedTime: description: "The most recent timestamp when the device was successfully validated using one time passcode\n\n**Added In:** 17.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsAllowUpdatesInReadOnlyMode: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string meta: $ref: '#/components/schemas/meta' nonCompliances: description: "Device Non Compliances\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name, value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/MyDeviceNonCompliances' type: array ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string packageId: description: "Mobile Authenticator App Package Id\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 256 minLength: 1 type: string phoneNumber: description: "User's Phone Number\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 40 minLength: 1 type: string platform: description: "Device Platform\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - IOS - ANDROID - WINDOWS - CELLULAR maxLength: 40 minLength: 1 type: string pushNotificationTarget: $ref: '#/components/schemas/MyDevicePushNotificationTarget' reason: description: "Additional comments/reasons for the change in device status\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array seed: description: "Attribute added for replication log, it is not used by IDCS, it is actual encrypted TOTP seed for the user\n\n**Added In:** 2111040242\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string seedDekId: description: "Attribute added for replication log, it is not used by IDCS, the DEK that encrypts the specific seed for that user\n\n**Added In:** 2111040242\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string status: description: "Device Status\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" enum: - INITIATED - INPROGRESS - INACTIVE - ENROLLED - LOCKED - BLOCKED maxLength: 15 minLength: 1 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyFactor: $ref: '#/components/schemas/MyDeviceThirdPartyFactor' user: $ref: '#/components/schemas/MyDeviceUser' required: - schemas - user - authenticationFactors type: object SelfRegistrationProfileEmailTemplate: description: "Email template\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: request\n - type: complex" properties: $ref: description: "URI of the Email Template\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Identifier of the Email Template.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object IdentityProviderJitUserProvGroupMappings: description: The list of mappings between the Identity Domain Group and the IDP group. properties: $ref: description: "Group URI\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: reference" type: string idpGroup: description: "IDP Group Name\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - type: string" maxLength: 256 type: string value: description: "Domain Group\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - idcsSearchable: true\n - type: string" maxLength: 40 type: string required: - value - $ref - idpGroup type: object UserExtOAuth2ClientCredentials: description: "A list of OAuth2 client credentials corresponding to a user.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding OAuth2ClientCredential resource to which the user belongs.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ocid: description: "The user's OAuth2 client credential OCID.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "The user's OAuth2 client credential identifier.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object UserExtAppRoles: description: "A list of all AppRoles to which this User belongs directly, indirectly or implicitly. The User could belong directly because the User is a member of the AppRole, could belong indirectly because the User is a member of a Group that is a member of the AppRole, or could belong implicitly because the AppRole is public.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the AppRole assigned to the User.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string adminRole: description: "If true, then the role provides administrative access privileges. READ-ONLY.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean appId: description: "The ID of the App that defines this AppRole.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string appName: description: "The name (Client ID) of the App that defines this AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string display: description: "The display name of the AppRole assigned to the User.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string legacyGroupName: description: "The name (if any) under which this AppRole should appear in this User's group-memberships for reasons of backward compatibility. Oracle Identity Cloud Service distinguishes between Groups and AppRoles, but some services still expect AppRoles appear as if they were service-instance-specific Groups.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "The kind of membership this User has in the AppRole. A value of 'direct' indicates that the User is a member of the AppRole. A value of 'indirect' indicates that the User is a member of a Group that is a member of the AppRole. A value of 'implicit' indicates that the AppRole is public.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" enum: - direct - indirect - implicit type: string value: description: "The Id of the AppRole assigned to the User.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value type: object UserExtDevices: description: "A list of devices enrolled by the user.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding Device resource which belongs to user.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string authenticationMethod: description: "The authentication method.\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string factorStatus: description: "The device authentication factor status.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string factorType: description: "The device authentication factor type.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string lastSyncTime: description: "The last sync time for device.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string status: description: "The device's status.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyVendorName: description: "The third-party factor vendor name.\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The user's device identifier.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value type: object UserExtAccounts: description: "Accounts assigned to this User. Each value of this attribute refers to an app-specific identity that is owned by this User. Therefore, this attribute is a convenience that allows one to see on each User the Apps to which that User has access.\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the Account assigned to the User.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string active: description: "Status of the account\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean appId: description: "The ID of the App to which this Account gives access.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "Name of the account assigned to the User.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The Id of the Account assigned to the User.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object SelfRegistrationProfileFooterText: description: Footer text properties: default: description: "If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean locale: description: "Type of user's locale e.g. en-CA\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(type)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Localized value of footer text in corresponding locale\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string required: - locale - value type: object AuthenticationFactorSettingsSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array required: - schemas type: object IdentityProviderJitProvAssignedGroups: description: "Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true.\n\n**Added In:** 2310202314\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Group URI\n\n**Added In:** 2310202314\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**Added In:** 2310202314\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string value: description: "Group identifier\n\n**Added In:** 2310202314\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AppRoleSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object UserPhotos: description: URLs of photos for the User properties: display: description: "A human readable name, primarily used for display purposes.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred photo or thumbnail. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label indicating the attribute's function; e.g., 'photo' or 'thumbnail'.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - photo - thumbnail type: string value: description: "URL of a photo for the User\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: reference\n - uniqueness: none" maxLength: 2000 minLength: 1 type: string required: - value - type type: object UserExtIdcsAppRolesLimitedToGroups: description: "Description:\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, idcsAppRoleId]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n" properties: $ref: description: "The URI of the SCIM resource representing the Group manager. RECOMMENDED.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Group display name\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsAppRoleId: description: "The id of the Oracle Identity Cloud Service AppRole grant limited to one or more Groups.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: IDCS AppRole Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string ocid: description: "The ocid of a Group the AppRole Grant is limited to\n\n**Added In:** 2202230830\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Group Ocid\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string value: description: "The id of a Group the AppRole Grant is limited to\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Group Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - idcsAppRoleId - value type: object AppScopes: description: Scopes defined by this App. Used when this App acts as an OAuth Resource. properties: description: description: "OAuth scope description\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string displayName: description: "OAuth scope display name\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string fqs: description: "The fully qualified value of this scope within this App. A fully qualified scope combines the 'value' of each scope with the value of 'audience'. Each value of 'fqs' must be unique across the system. Used only when this App acts as an OAuth Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: server" type: string readOnly: description: "If true, indicates that this value must be protected.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean requiresConsent: description: "If true, indicates that a user must provide consent to access this scope. Note: Used only when this App acts as an OAuth Resource.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean value: description: "OAuth scope.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value type: object ExtensionMfaUser: description: This extension defines attributes used to manage Multi-Factor Authentication within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA. properties: bypassCodes: description: "A list of bypass codes that belongs to the user.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtBypassCodes' type: array devices: description: "A list of devices enrolled by the user.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtDevices' type: array loginAttempts: description: "The number of incorrect multi factor authentication sign in attempts made by this user. The user is locked if this reaches the threshold specified in the maxIncorrectAttempts attribute in AuthenticationFactorSettings.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer mfaEnabledOn: description: "The date when the user enrolled in multi factor authentication. This will be set to null, when the user resets their factors.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string mfaIgnoredApps: description: "User MFA Ignored Apps Identifiers\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 40 minLength: 1 type: array mfaStatus: description: "The user opted for MFA.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - ENROLLED - IGNORED - UN_ENROLLED - DISABLED type: string preferredAuthenticationFactor: description: "The preferred authentication factor type.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - EMAIL - SMS - TOTP - PUSH - OFFLINETOTP - USERNAME_PASSWORD - SECURITY_QUESTIONS - VOICE - PHONE_CALL - THIRDPARTY - FIDO_AUTHENTICATOR - YUBICO_OTP maxLength: 40 minLength: 1 type: string preferredAuthenticationMethod: description: "The preferred authentication method.\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 80 type: string preferredDevice: $ref: '#/components/schemas/UserExtPreferredDevice' preferredThirdPartyVendor: description: "The preferred third-party vendor name.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string trustedUserAgents: description: "A list of trusted User Agents owned by this user. Multi-Factored Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests. For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, oneof several executing on a particular mobile device). A User Agent is trusted once the Multi-Factor Authentication has verified it in some way.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtTrustedUserAgents' type: array type: object AppSignonPolicy: description: "Sign-on Policy.\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "URI of the policy.\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Identifier of the Policy.\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object IdentityProviderJitUserProvAttributes: description: "Assertion To User Mapping\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Mapped Attribute URI\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Mapped Attribute identifier\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object NotificationSettingsSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array required: - schemas type: object AppAppResources: description: "A list of AppResources of this App.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "The URI of an AppResource of this App.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "The id of an AppResource of this App.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object SettingsCloudGateCorsSettings: description: "A complex attribute that specifies the Cloud Gate cross origin resource sharing settings.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: cloudGateCorsAllowNullOrigin: description: "Allow Null Origin (CORS) for this tenant.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean cloudGateCorsAllowedOrigins: description: "Cloud Gate Allowed Cross-Origin Resource Sharing (CORS) Origins for this tenant.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array cloudGateCorsEnabled: description: "Enable Cloud Gate Cross-Origin Resource Sharing (CORS) for this tenant.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean cloudGateCorsExposedHeaders: description: "List of Response Headers Cloud Gate is allowed to expose in the CORS Response Header: Access-Control-Expose-Headers.\n\n**Added In:** 2205182039\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array cloudGateCorsMaxAge: description: "Maximum number of seconds a CORS Pre-flight Response may be cached by client.\n\n**Added In:** 2205182039\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer type: object ApprovalWorkflowSteps: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/ApprovalWorkflowStep' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AuthenticationFactorsRemoverUser: description: "User for whom the authentication factors need to be deleted\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the member Resource for whom the factors will be deleted\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the user\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 400 minLength: 1 type: string value: description: "The identifier of the user\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value type: object SecurityQuestions: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/SecurityQuestion' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object KmsiSettings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/KmsiSetting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object ApprovalWorkflows: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/ApprovalWorkflow' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object OciConsoleSignOnPolicyConsentModifiedResource: description: "The modified Policy, Rule, ConditionGroup or Condition during consent signing.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: ocid: description: "The modified Policy, Rule, ConditionGroup, or Condition OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" maxLength: 255 minLength: 1 type: string type: description: "The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - idcsDefaultValue: Policy\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - Policy - Rule - ConditionGroup - Condition maxLength: 100 type: string value: description: "Modified Policy, Rule, ConditionGroup or Condition Id.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" maxLength: 40 minLength: 1 type: string required: - value - ocid - type type: object ExtensionThirdPartyAuthenticationFactorSettings: description: This extension defines attributes used to manage Multi-Factor Authentication settings of third party provider properties: duoSecuritySettings: $ref: '#/components/schemas/AuthenticationFactorSettingsDuoSecuritySettings' type: object Users: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/User' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object BrandingSettingsCompanyNames: description: Name of the company in different locales properties: locale: description: "Locale\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Company name\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string required: - value - locale type: object AccountMgmtInfoMatchingOwners: description: Matching owning users of the account properties: $ref: description: "User URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string email: description: "The email address of this user\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string userName: description: "User name\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "User Identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AuthenticationFactorSettingsNotificationSettings: description: "Settings related to the Mobile App Notification channel, such as pull\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: pullEnabled: description: "If true, indicates that the Mobile App Pull Notification channel is enabled for authentication\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - pullEnabled type: object SchemaReferencedResourceTypeUniqueAttributeNameMappings: description: This attribute specifies the mapping of "uniqueAttributeNameForDisplay" attributes(s) of the referenced resource with the columnHeaderName(s). This attribute should be given in the idcsCsvAttributeNameMappings when uniqueAttributeNameForDisplay contains more than one attribute. properties: mapsFromColumnName: description: "Specifies the CSV column header name that maps to the corresponding \\\"uniqueAttributeNameForDisplay\\\" attribute of the resource.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string resourceTypeAttributeName: description: "Specifies the name of the attribute given in \\\"uniqueAttributeNameForDisplay\\\" in the Resource type definition.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object MyAuthenticationFactorValidatorAdditionalAttributes: description: Additional attributes which will be sent as part of a push notification properties: name: description: "A name of the attribute\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Value of the attribute\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - name type: object ExtensionSffUser: description: SFF Auth Keys User extension properties: sffAuthKeys: description: "SFF auth keys clob\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string type: object RuleSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object UserExtSmtpCredentials: description: "A list of SMTP credentials corresponding to user.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding SmtpCredential resource to which the user belongs.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ocid: description: "The user's Auth token OCID.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "The user's SMTP credential identifier.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object MappedAttributeAttributeMappings: description: A list of attribute mappings between Oracle Identity Cloud Service Resource Type and Account Object Class properties: appliesToActions: description: "If specified, indicates a subset of mappedActions to which this attribute-mapping applies.If not specified, this attribute-mapping applies to all mappedActions that use mappedAttributes\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: enum: - create - update type: string type: array idcsAttributeName: description: "The name or expression of an attribute that corresponds to the Oracle Identity Cloud Service Resource referred in the \\\"idcsResourceType\\\" attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string managedObjectAttributeName: description: "The name or expression of an attribute defined in the schema of the Managed Object Class. This is the SCIM compliant Oracle Identity Cloud Service Name of the attribute that maps to the \\\"idcsName\\\" attribute in the schema of an Managed Object Class.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: description: "If true, indicates that this attribute must have a value. This attribute maps to the \\\"required\\\" sub-attribute in the schema of an Managed Object Class.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean samlFormat: description: "Indicates the format of the assertion attribute. Also stores AttributeNamespace for WSFed1.1.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string required: - managedObjectAttributeName - idcsAttributeName type: object MyAppUserWalletArtifact: description: "The UserWalletArtifact that contains the credentials that the system will use in performing Secure Form-Fill to log the User into this application.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "UserWalletArtifact URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "UserWalletArtifact identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object CloudGateExtUpstreamServerGroups: description: A list of upstream server groups properties: $ref: description: "URI of the upstream server groups\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string displayName: description: "Display name of upstream\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string nginxSettings: description: "Any additional settings in nginx configuration form\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ssl: description: "SSL flag for the Upstream Block\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean value: description: "Name for the Upstream Block\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value - displayName type: object UserPhoneNumbers: description: Phone numbers properties: display: description: "A human-readable name, primarily used for display purposes. READ ONLY\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string primary: description: "A Boolean value that indicates the 'primary' or preferred attribute value for this attribute--for example, the preferred phone number or primary phone number. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label that indicates the attribute's function- for example, 'work', 'home', or 'mobile'\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - work - home - mobile - fax - pager - other - recovery type: string value: description: "User's phone number\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string verified: description: "A Boolean value that indicates if the phone number is verified.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - value - type type: object CloudGateMappings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/CloudGateMapping' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object UserExtTermsOfUseConsents: description: "Description:\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none\n" properties: $ref: description: "The URI of the corresponding TermsOfUseConsent resource linked with the user\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: type: string required: - value type: object User: description: User Account properties: active: description: "User status\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Active\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Active]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean addresses: description: "A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [type]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Address Street, deprecatedColumnHeaderName:Work Street Address, mapsTo:addresses[work].streetAddress], [columnHeaderName:Work Address Locality, deprecatedColumnHeaderName:Work City, mapsTo:addresses[work].locality], [columnHeaderName:Work Address Region, deprecatedColumnHeaderName:Work State, mapsTo:addresses[work].region], [columnHeaderName:Work Address Postal Code, deprecatedColumnHeaderName:Work Postal Code, mapsTo:addresses[work].postalCode], [columnHeaderName:Work Address Country, deprecatedColumnHeaderName:Work Country, mapsTo:addresses[work].country], [columnHeaderName:Work Address Formatted, mapsTo:addresses[work].formatted], [columnHeaderName:Home Address Formatted, mapsTo:addresses[home].formatted], [columnHeaderName:Other Address Formatted, mapsTo:addresses[other].formatted], [columnHeaderName:Home Address Street, mapsTo:addresses[home].streetAddress], [columnHeaderName:Other Address Street, mapsTo:addresses[other].streetAddress], [columnHeaderName:Home Address Locality, mapsTo:addresses[home].locality], [columnHeaderName:Other Address Locality, mapsTo:addresses[other].locality], [columnHeaderName:Home Address Region, mapsTo:addresses[home].region], [columnHeaderName:Other Address Region, mapsTo:addresses[other].region], [columnHeaderName:Home Address Country, mapsTo:addresses[home].country], [columnHeaderName:Other Address Country, mapsTo:addresses[other].country], [columnHeaderName:Home Address Postal Code, mapsTo:addresses[home].postalCode], [columnHeaderName:Other Address Postal Code, mapsTo:addresses[other].postalCode], [columnHeaderName:Primary Address Type, mapsTo:addresses[$(type)].primary]]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/addresses' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description of the user\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsPii: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 400 minLength: 1 type: string displayName: description: "Display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Display Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Display Name]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 382 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string emails: description: "A complex attribute representing emails\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Email, mapsTo:emails[work].value], [columnHeaderName:Home Email, mapsTo:emails[home].value], [columnHeaderName:Primary Email Type, mapsTo:emails[$(type)].primary], [columnHeaderName:Other Email, mapsTo:emails[other].value], [columnHeaderName:Recovery Email, mapsTo:emails[recovery].value], [columnHeaderName:Work Email Verified, mapsTo:emails[work].verified], [columnHeaderName:Home Email Verified, mapsTo:emails[home].verified], [columnHeaderName:Other Email Verified, mapsTo:emails[other].verified], [columnHeaderName:Recovery Email Verified, mapsTo:emails[recovery].verified]]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserEmails' type: array entitlements: description: "A list of entitlements for the User that represent a thing the User has.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserEntitlements' type: array externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeNameMappings: [[columnHeaderName:External Id]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string groups: description: "A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserGroups' type: array id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array ims: description: "User's instant messaging addresses\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserIms' type: array locale: description: "Used to indicate the User's default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Locale\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Locale]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string meta: $ref: '#/components/schemas/meta' name: $ref: '#/components/schemas/UserName' nickName: description: "Nick name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Nick Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Nick Name]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 5 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string password: description: "Password attribute. Max length for password is controlled via Password Policy.\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Password\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Password]]\n - idcsPii: true\n - idcsSearchable: false\n - idcsSensitive: hash\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" maxLength: 500 minLength: 1 type: string phoneNumbers: description: "Phone numbers\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Phone, mapsTo:phoneNumbers[work].value], [columnHeaderName:Mobile No, mapsTo:phoneNumbers[mobile].value], [columnHeaderName:Home Phone, mapsTo:phoneNumbers[home].value], [columnHeaderName:Fax, mapsTo:phoneNumbers[fax].value], [columnHeaderName:Pager, mapsTo:phoneNumbers[pager].value], [columnHeaderName:Other Phone, mapsTo:phoneNumbers[other].value], [columnHeaderName:Recovery Phone, mapsTo:phoneNumbers[recovery].value], [columnHeaderName:Primary Phone Type, mapsTo:phoneNumbers[$(type)].primary]]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserPhoneNumbers' type: array photos: description: "URLs of photos for the User\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsPii: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserPhotos' type: array preferredLanguage: description: "User's preferred written or spoken language used for localized user interfaces\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Preferred Language\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Preferred Language]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string profileUrl: description: "A fully-qualified URL to a page representing the User's online profile\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Profile URL\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Profile Url]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" maxLength: 2000 minLength: 1 type: string roles: description: "A list of roles for the User that collectively represent who the User is; e.g., 'Student', 'Faculty'.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserRoles' type: array schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string timezone: description: "User's timezone\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"timezones\" and attrValues.value eq \"$(timezone)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsCsvAttributeName: TimeZone\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Time Zone, deprecatedColumnHeaderName:TimeZone]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string title: description: "Title\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Title\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Title]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 1 type: string urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: $ref: '#/components/schemas/ExtensionEnterprise20User' urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags: $ref: '#/components/schemas/ExtensionOCITags' urn:ietf:params:scim:schemas:oracle:idcs:extension:adaptive:User: $ref: '#/components/schemas/ExtensionAdaptiveUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:capabilities:User: $ref: '#/components/schemas/ExtensionCapabilitiesUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:dbCredentials:User: $ref: '#/components/schemas/ExtensionDbCredentialsUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:dbUser:User: $ref: '#/components/schemas/ExtensionDbUserUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:kerberosUser:User: $ref: '#/components/schemas/ExtensionKerberosUserUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:mfa:User: $ref: '#/components/schemas/ExtensionMfaUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordState:User: $ref: '#/components/schemas/ExtensionPasswordStateUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordless:User: $ref: '#/components/schemas/ExtensionPasswordlessUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:User: $ref: '#/components/schemas/ExtensionPosixUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:securityQuestions:User: $ref: '#/components/schemas/ExtensionSecurityQuestionsUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:selfRegistration:User: $ref: '#/components/schemas/ExtensionSelfRegistrationUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:sff:User: $ref: '#/components/schemas/ExtensionSffUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:socialAccount:User: $ref: '#/components/schemas/ExtensionSocialAccountUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:termsOfUse:User: $ref: '#/components/schemas/ExtensionTermsOfUseUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User: $ref: '#/components/schemas/ExtensionUserUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:userCredentials:User: $ref: '#/components/schemas/ExtensionUserCredentialsUser' urn:ietf:params:scim:schemas:oracle:idcs:extension:userState:User: $ref: '#/components/schemas/ExtensionUserStateUser' userName: description: "User name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: User ID\n - idcsCsvAttributeNameMappings: [[columnHeaderName:User Name, deprecatedColumnHeaderName:User ID]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 256 minLength: 1 type: string userType: description: "Used to identify the organization-to-user relationship\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: User Type\n - idcsCsvAttributeNameMappings: [[columnHeaderName:User Type]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Contractor - Employee - Intern - Temp - External - Service - Generic type: string x509Certificates: description: "A list of certificates issued to the User.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserX509Certificates' type: array required: - schemas - userName type: object PolicySearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object AppThreeLeggedOAuthCredential: description: "The value of this attribute persists any OAuth access token that the system uses to connect to this ManagedApp. The system obtains this access token using an OAuth protocol flow that could be two-legged or three-legged. A two-legged flow involves only the requester and the server. A three-legged flow also requires the consent of a user -- in this case the consent of an administrator.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: accessToken: description: "Access Token\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsSensitive: encrypt\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string accessTokenExpiry: description: "Access token expiry\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string refreshToken: description: "Refresh Token\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - idcsSensitive: encrypt\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object IdentitySettingsMyProfile: description: "Whether to allow users to update their own profile.\n\n**Added In:** 2207040824\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - required: false\n - type: complex\n - uniqueness: none" properties: allowEndUsersToChangeTheirPassword: description: "Whether to allow users to change their own password.\n\n**Added In:** 2207040824\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean allowEndUsersToLinkTheirSupportAccount: description: "Whether to allow users to link or unlink their support accounts.\n\n**Added In:** 2207040824\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean allowEndUsersToManageTheirCapabilities: description: "Whether to allow users to update their capabilities.\n\n**Added In:** 2207040824\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean allowEndUsersToUpdateTheirSecuritySettings: description: "Whether to allow users to update their security settings.\n\n**Added In:** 2207040824\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: object MyOAuth2ClientCredentials: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyOAuth2ClientCredential' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object CloudGateServer: description: Resource representing a Cloud Gate server block properties: cloudGate: $ref: '#/components/schemas/CloudGateServerCloudGate' compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Brief description for this Cloud Gate server block\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 minLength: 1 type: string displayName: description: "Display name for the Server block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: server" maxLength: 250 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string hostName: description: "Hostname for the Server block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isOPCService: description: "Indicates whether this resource was created by OPC\n\n**Added In:** 19.3.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: boolean\n - uniqueness: none" type: boolean meta: $ref: '#/components/schemas/meta' nginxSettings: description: "More nginx Settings. JSON encoded text block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string port: description: "Port for the Server Block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsMaxValue: 65535\n - idcsMinValue: 1\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array ssl: description: "SSL flag for the Server Block\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - displayName - hostName - port - ssl - cloudGate type: object UserExtPreferredDevice: description: "The user's preferred device.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the device resource.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The device display name.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The user's preferred device identifier.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object UserExtCustomerSecretKeys: description: "A list of customer secret keys corresponding to user.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding CustomerSecretKey resource to which the user belongs.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ocid: description: "The user's customer secret key OCID.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "The user's customer secret key identifier.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object MyRequestableGroup: description: The Group resource. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean displayName: description: "The Group display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Display Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Name, deprecatedColumnHeaderName:Display Name]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 3000 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array members: description: "The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use 'startIndex' and 'count' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:User Members, mapsTo:members[User].value, multiValueDelimiter:;]]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - idcsPaginateResponse: true\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MyRequestableGroupMembers' type: array meta: $ref: '#/components/schemas/meta' nonUniqueDisplayName: description: "A human readable name for the group as defined by the Service Consumer.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Non-Unique Display Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string" maxLength: 3000 minLength: 1 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group: $ref: '#/components/schemas/ExtensionGroupGroup' urn:ietf:params:scim:schemas:oracle:idcs:extension:requestable:Group: $ref: '#/components/schemas/ExtensionRequestableGroup' required: - schemas - displayName type: object AuthenticationFactorSettings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/AuthenticationFactorSetting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppAllowedTags: description: A list of tags, acting as an OAuthClient, this App is allowed to access. properties: key: description: "Key or name of the allowed tag.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string readOnly: description: "If true, indicates that this value must be protected.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean value: description: "Value of the allowed tag.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string required: - key - value type: object NotificationSettings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/NotificationSetting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AuthenticationFactorSettingsClientAppSettings: description: "Settings related to compliance, Personal Identification Number (PIN) policy, and so on\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: deviceProtectionPolicy: description: "Indicates what protection policy that the system applies on a device. By default, the value is NONE, which indicates that the system applies no protection policy. A value of APP_PIN indicates that the system requires a Personal Identification Number (PIN). A value of DEVICE_BIOMETRIC_OR_APP_PIN indicates that either a PIN or a biometric authentication factor is required.\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"deviceProtectionPolicy\" and attrValues.value eq \"$(deviceProtectionPolicy)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string initialLockoutPeriodInSecs: description: "The period of time in seconds that the system will lock a user out of the service after that user exceeds the maximum number of login failures\n\n**SCIM++ Properties:**\n - idcsMaxValue: 86400\n - idcsMinValue: 30\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer keyPairLength: description: "The size of the key that the system uses to generate the public-private key pair\n\n**SCIM++ Properties:**\n - idcsMaxValue: 4000\n - idcsMinValue: 32\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer lockoutEscalationPattern: description: "The pattern of escalation that the system follows, in locking a particular user out of the service.\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"lockoutEscalationPattern\" and attrValues.value eq \"$(lockoutEscalationPattern)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string maxFailuresBeforeLockout: description: "The maximum number of times that a particular user can fail to login before the system locks that user out of the service\n\n**SCIM++ Properties:**\n - idcsMaxValue: 10\n - idcsMinValue: 5\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxFailuresBeforeWarning: description: "The maximum number of login failures that the system will allow before raising a warning and sending an alert via email\n\n**SCIM++ Properties:**\n - idcsMaxValue: 10\n - idcsMinValue: 0\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxLockoutIntervalInSecs: description: "The maximum period of time that the system will lock a particular user out of the service regardless of what the configured pattern of escalation would otherwise dictate\n\n**SCIM++ Properties:**\n - idcsMaxValue: 86400\n - idcsMinValue: 30\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minPinLength: description: "Minimum length of the Personal Identification Number (PIN)\n\n**SCIM++ Properties:**\n - idcsMaxValue: 10\n - idcsMinValue: 6\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer policyUpdateFreqInDays: description: "The period of time in days after which a client should refresh its policy by re-reading that policy from the server\n\n**SCIM++ Properties:**\n - idcsMaxValue: 999\n - idcsMinValue: 1\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer requestSigningAlgo: description: "Indicates which algorithm the system will use to sign requests\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - SHA256withRSA - SHA384withRSA - SHA512withRSA type: string sharedSecretEncoding: description: "Indicates the type of encoding that the system should use to generate a shared secret\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - Base32 - Base64 type: string unlockAppForEachRequestEnabled: description: "If true, indicates that the system should require the user to unlock the client app for each request. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean unlockAppIntervalInSecs: description: "Specifies the period of time in seconds after which the client App should require the user to unlock the App. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. A value of zero means that it is disabled.\n\n**SCIM++ Properties:**\n - idcsMaxValue: 9999999\n - idcsMinValue: 0\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer unlockOnAppForegroundEnabled: description: "If true, indicates that the system should require the user to unlock the client App, when the client App comes to the foreground in the display of the device. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean unlockOnAppStartEnabled: description: "If true, indicates that the system should require the user to unlock the client App whenever the App is started. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - minPinLength - maxFailuresBeforeWarning - maxFailuresBeforeLockout - initialLockoutPeriodInSecs - lockoutEscalationPattern - maxLockoutIntervalInSecs - requestSigningAlgo - policyUpdateFreqInDays - keyPairLength - deviceProtectionPolicy - unlockAppForEachRequestEnabled - unlockOnAppStartEnabled - unlockAppIntervalInSecs - sharedSecretEncoding - unlockOnAppForegroundEnabled type: object UserExtApiKeys: description: "A list of API keys corresponding to user.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding ApiKey resource to which the user belongs.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string key: description: "The user's API key value.\n\n**Added In:** 2106240046\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's API key OCID.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "The user's API key identifier.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object BrandingSetting: description: Brand Settings schema properties: companyNames: description: "Name of the company in different locales\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/BrandingSettingsCompanyNames' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string customBranding: description: "Indicates if the branding is default or is custom branding\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean customCssLocation: description: "Storage URL location where the sanitized custom css is located\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string customHtmlLocation: description: "Storage URL location where the sanitized custom html is located\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string customTranslation: description: "Custom translations (JSON String)\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string defaultCompanyNames: description: "Default name of the Company in different locales\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/BrandingSettingsDefaultCompanyNames' type: array defaultImages: description: "References to various images\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [type]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/BrandingSettingsDefaultImages' type: array defaultLoginTexts: description: "Default Login text in different locales\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/BrandingSettingsDefaultLoginTexts' type: array deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string enableTermsOfUse: description: "Indicates if Terms of Use is enabled in UI\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array images: description: "References to various images\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [type]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/BrandingSettingsImages' type: array isHostedPage: description: "Indicates if 'hosted' option was selected\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean locale: description: "Default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string loginTexts: description: "Login text in different locales\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/BrandingSettingsLoginTexts' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string preferredLanguage: description: "Preferred written or spoken language used for localized user interfaces\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string privacyPolicyUrl: description: "Privacy Policy URL\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string termsOfUseUrl: description: "Terms of Use URL\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string timezone: description: "User's timezone\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string required: - schemas type: object Grants: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/Grant' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object ApprovalWorkflowApprovalWorkflowSteps: description: ApprovalWorkflowSteps applicable for the ApprovalWorkflowInstance. properties: $ref: description: "ApprovalWorkflowSteps URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ocid: description: "The unique OCI identifier of the ApprovalWorkflowStep.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string order: description: "The order of the ApprovalWorkflowSteps.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer type: description: "The type of the ApprovalWorkflowSteps.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The unique identifier of the ApprovalWorkflowStep.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object SecurityQuestionSetting: description: Security Question Settings properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array maxFieldLength: description: "Indicates the maximum length of following fields Security Questions, Answer and Hint\n\n**SCIM++ Properties:**\n - type: integer\n - multiValued: false\n - returned: default\n - caseExact: false\n - mutability: readWrite\n - required: true\n - uniqueness: none\n - idcsMinValue: 5\n - idcsMaxValue: 100" type: integer meta: $ref: '#/components/schemas/meta' minAnswerLength: description: "Indicates the minimum length of answer for security questions\n\n**SCIM++ Properties:**\n - type: integer\n - multiValued: false\n - required: true\n - caseExact: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsMinValue: 1\n - idcsMaxValue: 8" type: integer numQuestionsToAns: description: "Indicates the number of security questions that a user must answer\n\n**SCIM++ Properties:**\n - type: integer\n - multiValued: false\n - returned: default\n - caseExact: false\n - mutability: readWrite\n - required: true\n - uniqueness: none\n - idcsMinValue: 1\n - idcsMaxValue: 5" type: integer numQuestionsToSetup: description: "Indicates the number of security questions a user must setup\n\n**SCIM++ Properties:**\n - type: integer\n - multiValued: false\n - required: true\n - caseExact: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsMinValue: 1\n - idcsMaxValue: 5" type: integer ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - numQuestionsToSetup - minAnswerLength - maxFieldLength - numQuestionsToAns type: object GrantEntitlement: description: "The entitlement or privilege that is being granted\n\n**SCIM++ Properties:**\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Entitlement Value, csvColumnForResolvingResourceType:Entitlement Name, mapsTo:entitlement.attributeValue, referencedResourceTypeUniqueAttributeNameMappings:[[mapsFromColumnName:Entitlement Value, resourceTypeAttributeName:displayName], [mapsFromColumnName:App Name, resourceTypeAttributeName:app.display]], resolveValueUsingResourceType:[[resolveBy:AppRole, valueToBeResolved:appRoles]]], [columnHeaderName:Entitlement Name, defaultValue:appRoles, mapsTo:entitlement.attributeName]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex" properties: attributeName: description: "The name of the attribute whose value (specified by attributeValue) confers privilege within the service-instance (specified by app).\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string attributeValue: description: "The value of the attribute (specified by attributeName) that confers privilege within the service-instance (specified by app). If attributeName is 'appRoles', then attributeValue is the ID of the AppRole.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeName: Display Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 1 type: string required: - attributeName - attributeValue type: object ExtensionSelfRegistrationUser: description: This extension defines attributes used to manage self registration profile linked to the user. properties: consentGranted: description: "A boolean value that indicates whether the consent is granted.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean selfRegistrationProfile: $ref: '#/components/schemas/UserExtSelfRegistrationProfile' userToken: description: "User token used for auto-login.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - selfRegistrationProfile type: object MySmtpCredential: description: User's smtp credential properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "User credential expires on\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "User credential status\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string user: $ref: '#/components/schemas/MySmtpCredentialUser' userName: description: "User name\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readOnly\n - required: true\n - returned: default" maxLength: 4000 type: string required: - schemas - userName type: object MyRequestSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MePasswordChanger: description: The schema used for a user changing their own password. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string oldPassword: description: "The old password attribute.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: true\n - mutability: writeOnly\n - returned: never\n - uniqueness: none\n - caseExact: false\n - idcsSensitive: none\n - idcsSearchable: false" maxLength: 500 minLength: 1 type: string password: description: "Password attribute. The maximum length for a password is controlled by a password policy.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: true\n - mutability: writeOnly\n - returned: never\n - uniqueness: none\n - caseExact: false\n - idcsSensitive: hash\n - idcsSearchable: false" maxLength: 500 minLength: 1 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - password - oldPassword type: object MyTrustedUserAgentUser: description: "user for whom the trust-token was issued\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Full URI to the user for whom the trust-token was issued.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: true\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Friendly name of the User to be used for purposes of display.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the user\n\n**Added In:** 2105091740\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 400 minLength: 1 type: string value: description: "The SCIM ID of the user for whom the trust-token was issued.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - $ref type: object GrantGrantee: description: "Grantee beneficiary. The grantee may be a User, Group, App or DynamicResourceGroup.\n\n**SCIM++ Properties:**\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Grantee Name, csvColumnForResolvingResourceType:Grantee Type, mapsTo:grantee.value], [columnHeaderName:Grantee Type, mapsTo:grantee.type]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Grantee URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Grantee display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string type: description: "Grantee resource type. Allowed values are User, Group, App and DynamicResourceGroup.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeName: Member Type\n - idcsDefaultValue: User\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - Group - App - DynamicResourceGroup type: string value: description: "Grantee identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeName: Member\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object SchemaSubAttributes: description: A list specifying the contained attributes properties: canonicalValues: description: "A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \\\"work\\\", \\\"home\\\".\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array caseExact: description: "Specifies if the String attribute is case-sensitive\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean description: description: "Attribute's human-readable description\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsAddedSinceReleaseNumber: description: "Indicates that the schema has been added since this release number\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string idcsAddedSinceVersion: description: "Indicates that the schema has been added since version\n\n**Deprecated Since: 19.3.3**\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsAttributeCacheable: description: "Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \\\"attributesToGet\\\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsAttributeMappable: description: "Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP. If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsAuditable: description: "Specifies whether changes to this attribute value will be audited\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsCanonicalValueSourceDisplayAttrName: description: "Display name for the canonical value attribute name.\n\n**Added In:** 17.4.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceFilter: description: "Filter to use when getting canonical values for this schema attribute\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceKeyAttrName: description: "Source key attribute for the canonical value.\n\n**Added In:** 17.4.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceResourceType: description: "Specifies the Resource type to read from for dynamic canonical values\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceResourceTypeID: description: "Specifies the Resource type ID to read from for dynamic canonical values\n\n**Added In:** 17.4.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCsvAttributeName: description: "The attribute that defines the CSV header name for import/export\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsDefaultValue: description: "Specifies the default value for an attribute. The value must be one from canonicalValues if defined.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsDeprecatedSinceReleaseNumber: description: "Indicates that the schema has been deprecated since this release number\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string idcsDeprecatedSinceVersion: description: "Indicates that the schema has been deprecated since version\n\n**Deprecated Since: 19.3.3**\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsDisplayName: description: "Specifies the user-friendly displayable attribute name or catalog key used for localization\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsDisplayNameMessageId: description: "Localized schema attribute display name for use by UI client for displaying attribute labels\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsExcludeFromUpgradePatch: description: "Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.\n\n**Added In:** 2104150946\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: boolean" type: boolean idcsFromTargetMapper: description: "Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsGenerated: description: "Specifies whether this attribute value was generated\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsIndirectRefResourceAttributes: description: "Specifies the indirectly referenced Resources\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" items: type: string type: array idcsInternal: description: "Specifies whether the schema attribute is for internal use only. Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internal flag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsMaxLength: description: "Specifies the maximum length of this attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsMaxValue: description: "Specifies the maximum value of the integer attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer" type: integer idcsMaxValuesReturned: description: '**SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: integer - uniqueness: none Specify a limit on the number of attribute-values that any caller will receive when requesting a CMVA attribute. If the no of CMVA instances exceeds the limit then Oracle Identity Cloud Service will throw exception. Users can choose to refine the filter on CMVA attribute. ' type: integer idcsMinLength: description: "Specifies the minimum length of this attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsMinValue: description: "Specifies the minimum value of the integer attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer" type: integer idcsOneValueMustBeTrue: description: "If true, ARM will ensure atleast one of the instances of CMVA has the attribute value set to true.\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsOnlyOneValueCanBeTrue: description: "If true, specifies that the sub attribute value can be set to true on one and only one instance of the CMVA.\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsPii: description: "Specifies whether the attribute is PII (personal information). False by default for all attributes. If attribute with idcsPii = true, it's value must be obfuscated before it's written to the Oracle Identity Cloud Service system logs.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsRefResourceAttributes: description: "Specifies the directly referenced Resources\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" items: type: string type: array idcsRequiresImmediateReadAfterWriteForAccessFlows: description: "If true, indicates that the attribute value must be written to the home region and requires immediate read-after-write consistency for access flows initiated from a replica region.\n\n**Added In:** 2209220956\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: boolean" type: boolean idcsRequiresWriteForAccessFlows: description: "If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsReturnEmptyWhenNull: description: "Specifies if the attribute is required\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsRtsaHideAttribute: description: "Specifies if the attributes in this schema can be displayed externally\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsSanitize: description: "Specifies if the value of the attribute should be sanitized using OWASP library for HTML content\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsScimCompliant: description: "Indicates if the attribute is scim compliant, default is true\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsSearchable: description: "Specifies whether this attribute can be included in a search filter\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsSensitive: description: "Specifiees if the attribute should be encrypted or hashed\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - encrypt - hash - hash_sc - checksum - none type: string idcsTargetAttributeName: description: "Target attribute name that this attribute gets mapped to for persistence\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetAttributeNameToMigrateFrom: description: "Old Target attribute name from child table for CSVA attribute prior to migration. This maintains this attribute used to get mapped to for persistence\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetNormAttributeName: description: "Target normalized attribute name that this normalized value of attribute gets mapped to for persistence. Only set for caseExact=false & searchable attributes. Do not use by default.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetUniqueConstraintName: description: "Target index name created for this attribute for performance\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsToTargetMapper: description: "Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTrimStringValue: description: "Trims any leading and trailing blanks from String values. Default is True.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsValidateReference: description: "Validate payload reference value during create, replace, and update. Default is True.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsValuePersisted: description: "Specifies whether the sub-attribute of the Resource attribute is persisted\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsValuePersistedInOtherAttribute: description: "If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsuiOrder: description: "Metadata used by Oracle Identity Cloud Service UI to sequence the attributes displayed on the Account Form.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsuiRegexp: description: "Metadata used by Oracle Identity Cloud Service UI to validate the attribute values using regular expressions.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string idcsuiVisible: description: "Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsuiWidget: description: "Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" enum: - inputtext - checkbox - textarea - combobox type: string multiValued: description: "Indicates the attribute's plurality\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean mutability: description: "Specifies if the attribute is mutable\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - readOnly - readWrite - immutable - writeOnly type: string name: description: "Attribute's name\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string referenceTypes: description: "The names of the Resource types that may be referenced--for example, User. This is only applicable for attributes that are of the \\\"reference\\\" data type.\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array required: description: "Specifies if the attribute is required\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean returned: description: "A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - always - never - default - request type: string type: description: "Attribute's data type--for example, String\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - string - complex - boolean - decimal - integer - dateTime - reference - binary type: string uniqueness: description: "A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has a uniqueness of \\\"none\\\".\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - none - server - global type: string type: object AppStatusChanger: description: Schema for AppStatusChanger resource. properties: active: description: "Application status\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - active type: object SocialIdentityProviderJitProvAssignedGroups: description: Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true. properties: $ref: description: "Group URI\n\n**Added In:** 2309290043\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**Added In:** 2309290043\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string value: description: "Group identifier\n\n**Added In:** 2309290043\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object MyRequest: description: Request resource properties: action: description: "Requestor can set action to CANCEL to cancel the request or to ESCALATE to escalate the request while the request status is IN_PROGRESS. Requestor can't escalate the request if canceling or escalation is in progress.\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - CANCEL - ESCALATE maxLength: 100 type: string approvalDetails: description: "Approvals created for this request.\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MyRequestApprovalDetails' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expires: description: "Time by when Request expires\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array justification: description: "justification\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 400 minLength: 1 type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string requesting: $ref: '#/components/schemas/MyRequestRequesting' requestor: $ref: '#/components/schemas/MyRequestRequestor' schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "status\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - CREATED - COMPLETE - IN_PROGRESS - APPROVED - REJECTED - CANCELED - EXPIRED - FAILED type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - justification - requesting type: object IdentitySettings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/IdentitySetting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppFlatFileConnectorBundle: description: "Flat file connector bundle to sync from a flat file.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "ConnectorBundle URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "ConnectorBundle display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "ConnectorBundle identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string wellKnownId: description: "Unique well-known identifier used to reference connector bundle.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string required: - value type: object AppAccounts: description: Accounts of App properties: $ref: description: "AccountMgmtInfo URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string active: description: "Status of the account\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean name: description: "Name of the account\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ownerId: description: "Owner identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Account identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object CloudGateMappingUpstreamServerGroup: description: "Reference to upstream block for this mapping\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI to the upstream block entry\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ssl: description: "SSL flag for the Upstream Block\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean value: description: "The id of the upstream block entry.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string type: object AccountRecoverySetting: description: Account Recovery Settings properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string factors: description: "The account recovery factor used (for example, email, mobile number (SMS), security questions, mobile application push or TOTP) to verify the identity of the user and reset the user's password.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: enum: - email - sms - secquestions - push - totp type: string type: array id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array lockoutDuration: description: "Indicates how many minutes to disable account recovery for the user. The default value is 30 metric minutes.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none\n - idcsMinValue: 5\n - idcsMaxValue: 9999" type: integer maxIncorrectAttempts: description: "Indicates the maximum number of failed account recovery attempts allowed for the user.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none\n - idcsMinValue: 1\n - idcsMaxValue: 99" type: integer meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - factors - maxIncorrectAttempts - lockoutDuration type: object AppExtensionKerberosRealmApp: description: Kerberos Realm properties: defaultEncryptionSaltType: description: "The type of salt that the system will use to encrypt Kerberos-specific artifacts of this App unless another type of salt is specified.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string masterKey: description: "The primary key that the system should use to encrypt artifacts that are specific to this Kerberos realm -- for example, to encrypt the Principal Key in each KerberosRealmUser.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string maxRenewableAge: description: "Max Renewable Age in seconds\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: integer\n - uniqueness: none" type: integer maxTicketLife: description: "Max Ticket Life in seconds\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: integer\n - uniqueness: none" type: integer realmName: description: "The name of the Kerberos Realm that this App uses for authentication.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string supportedEncryptionSaltTypes: description: "The types of salt that are available for the system to use when encrypting Kerberos-specific artifacts for this App.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: type: string maxLength: 100 minLength: 1 type: array ticketFlags: description: "Ticket Flags\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: integer\n - uniqueness: none" type: integer type: object MyDeviceThirdPartyFactor: description: "User's third-party authentication factor details\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the third party device resource\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" type: string thirdPartyFactorType: description: "Type of the third party authentication factor\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 80 minLength: 1 type: string thirdPartyVendorName: description: "The vendor name of the third party factor\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 80 minLength: 1 type: string value: description: "The identifier of third party device\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 80 minLength: 1 type: string required: - thirdPartyVendorName - value type: object IdentityPropagationTrustImpersonationServiceUsers: description: The Impersonating Principal. properties: $ref: description: "The URI that corresponds to the Service User.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ocid: description: "The OCID of the Service User.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 type: string rule: description: "The rule expression to be used for matching the inbound token for impersonation.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string value: description: "The ID of the Service User.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value - rule type: object Schema: description: SCIM schema properties: attributes: description: "A complex type that specifies the set of Resource attributes\n\n**SCIM++ Properties:**\n - idcsCompositeKey: []\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SchemaAttributes' type: array description: description: "Schema's human-readable description\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsAttributeCacheable: description: "Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \\\"attributesToGet\\\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsMappable: description: "Specifies if the attributes in this schema can be used for mapping with external identity sources such as AD or LDAP\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsMapsToSameTargetAttributeNameAs: description: "Contains the canonical name of the other attribute sharing the same idcsTargetAttributeName\n\n**Added In:** 2209122038\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string idcsOverrideCommonAttribute: description: "Specifies whether the dataprovider mapping from resource schema should override from common schema with the same name.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsResourceTypes: description: "Resource types defs this resource refers to\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array name: description: "Schema's human-readable name\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array required: - schemas - idcsMappable type: object CloudGateMappingSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object ExtensionOCITags: description: OCI Tags. properties: definedTags: description: "OCI Defined Tags\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [namespace, key, value]\n - type: complex\n - idcsSearchable: true\n - required: false\n - mutability: readWrite\n - multiValued: true\n - returned: default" items: $ref: '#/components/schemas/definedTags' type: array freeformTags: description: "OCI Freeform Tags\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - type: complex\n - required: false\n - mutability: readWrite\n - returned: default\n - multiValued: true" items: $ref: '#/components/schemas/freeformTags' type: array tagSlug: description: "OCI Tag slug\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - type: binary\n - mutability: readOnly\n - returned: request" maxLength: 4001 type: object type: object MyApiKeyUser: description: "The user linked to the API key.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The username.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object RestoreOciConsolePolicy: description: Schema to restoring OCI Console Policy to Factory Defaults. properties: compartmentOcid: description: '**SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none OCI Compartment Id (ocid) in which the resource lives.' type: string consent: description: '**SCIM++ Properties:** - idcsSearchable: false - multiValued: false - required: true - mutability: writeOnly - returned: default - type: boolean Consent to be provided for restoring the Oci Console SignOn Policy to Factory Defaults. Defaults to false' type: boolean deleteInProgress: description: '**SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none 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.' type: boolean domainOcid: description: '**SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none OCI Domain Id (ocid) in which the resource lives.' type: string id: description: '**SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global 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.' type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: '**SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none The release number when the resource was upgraded.' type: string idcsPreventedOperations: description: '**SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.' items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: '**SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global Unique OCI identifier for the SCIM Resource.' maxLength: 255 type: string reason: description: '**SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: writeOnly - required: true - returned: default - type: string Detailed reason when domain admin opts to restore the Oci Console SignOn Policy to Factory Defaults' maxLength: 250 minLength: 5 type: string schemas: description: '**SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none 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.' items: type: string type: array tags: description: '**SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsCsvAttributeNameMappings: [[columnHeaderName:Tag Key, mapsTo:tags.key], [columnHeaderName:Tag Value, mapsTo:tags.value]] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none A list of tags on this resource.' items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: '**SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none OCI Tenant Id (ocid) in which the resource lives.' type: string required: - schemas - consent - reason type: object BrandingSettingsImages: description: References to various images properties: display: description: "A human-readable name, primarily used for display purposes\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string" type: string type: description: "Indicates the image type\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Image URI\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: reference" type: string required: - value - type type: object SchemaIdcsCsvAttributeNameMappings: description: Csv meta data for those resource type attributes which can be imported / exported from / to csv. properties: columnHeaderName: description: "The CSV column header name that maps to this attribute.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string csvColumnForResolvingResourceType: description: "This specifies the Csv Header for resolving Resource Type for this Column Header\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string defaultValue: description: "The default value to be used during import processing in case the CSV column header is not present or value is not given in the import CSV.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deprecatedColumnHeaderName: description: "The deprecated CSV column header name that maps to this attribute.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string mapsTo: description: "The attribute path that the CSV column header name maps to for complex multi-valued attributes.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string multiValueDelimiter: description: "If values of the CSV column header name can contain multiple values, this attribute specifies the delimiter to be used. For example, Group's \\\"User Members\\\" CSV column header is multi-valued and it's delimiter is a semi-colon (\\\";\\\").\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string referencedResourceTypeUniqueAttributeNameMappings: description: "This attribute specifies the mapping of \\\"uniqueAttributeNameForDisplay\\\" attributes(s) of the referenced resource with the columnHeaderName(s). This attribute should be given in the idcsCsvAttributeNameMappings when uniqueAttributeNameForDisplay contains more than one attribute.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SchemaReferencedResourceTypeUniqueAttributeNameMappings' type: array resolveValueUsingResourceType: description: "This attribute gives a maps for resolving Resource Type after reading it's value from \\\"csvColumnForResolvingResourceType\\\" attribute\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SchemaResolveValueUsingResourceType' type: array type: object MyRequestRequesting: description: "Requestable resource reference.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Resource URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string description: description: "Resource description\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string display: description: "Resource display name\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "Requestable type. Allowed values are Group and App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeName: Requestable Type\n - idcsDefaultValue: Group\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - Group - App maxLength: 40 minLength: 1 type: string value: description: "Resource identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeName: requesting_id\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object AuthTokenSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object AppAttrRenderingMetadata: description: Label for the attribute to be shown in the UI. properties: datatype: description: "Data type of the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string helptext: description: "Help text for the attribute. It can contain HTML tags.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string label: description: "Label for the attribute to be shown in the UI.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string maxLength: description: "Maximum length of the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxSize: description: "Maximum size of the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minLength: description: "Minimum length of the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minSize: description: "Minimum size of the attribute..\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer name: description: "Name of the attribute.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string order: description: "Data type of the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer readOnly: description: "Is the attribute readOnly.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean regexp: description: "Regular expression of the attribute for validation.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: description: "Attribute is required or optional.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean section: description: "UI widget to use for the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - saml - general type: string visible: description: "Indicates whether the attribute is to be shown on the application creation UI.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean widget: description: "UI widget to use for the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - inputtext - checkbox - textarea type: string required: - name type: object MyAuthTokens: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyAuthToken' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppProtectableSecondaryAudiences: description: 'A list of secondary audiences--additional URIs to be added automatically to any OAuth token that allows access to this App. Note: This attribute is used mainly for backward compatibility in certain Oracle Public Cloud Apps.' properties: readOnly: description: "If true, indicates that this value must be protected.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean value: description: "The value of an secondary audience--additional URI to be added automatically to any OAuth token that allows access to this App.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value type: object AuthToken: description: The user's Auth token resource. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 400 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "When the user's credential expire.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "The user's credential status.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' user: $ref: '#/components/schemas/AuthTokenUser' required: - schemas type: object freeformTags: description: "OCI Freeform Tags\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - type: complex\n - required: false\n - mutability: readWrite\n - returned: default\n - multiValued: true" properties: key: description: "OCI Tag key\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - required: true\n - mutability: readWrite\n - returned: default\n - idcsSearchable: true\n - uniqueness: none" maxLength: 100 type: string value: description: "OCI Tag value\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - required: true\n - idcsReturnEmptyWhenNull: true\n - mutability: readWrite\n - returned: default\n - type: string\n - idcsSearchable: true\n - uniqueness: none" maxLength: 256 type: string required: - key - value type: object DynamicResourceGroupSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object AppRoleApp: description: "A unique identifier for the application that references this role.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - idcsCsvAttributeNameMappings: [[columnHeaderName:App Name, mapsTo:app.display]]\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "App URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "App display name\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string name: description: "Application name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string serviceInstanceIdentifier: description: "The serviceInstanceIdentifier of the App that defines this AppRole. This value will match the opcServiceInstanceGUID of any service-instance that the App represents.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "App identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object ExtensionTermsOfUseUser: description: Terms Of Use extension properties: termsOfUseConsents: description: "Description:\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none\n" items: $ref: '#/components/schemas/UserExtTermsOfUseConsents' type: array type: object UserExtUserToken: description: "User token returned if userFlowControlledByExternalClient is true\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "User Token URI\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "User Token identifier\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object ExtensionFidoAuthenticationFactorSettings: description: This extension defines attributes used to manage Multi-Factor Authentication settings of fido authentication properties: attestation: description: "Attribute used to define the type of attestation required.\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - NONE - DIRECT - INDIRECT type: string authenticatorSelectionAttachment: description: "Attribute used to define authenticator selection attachment.\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - PLATFORM - CROSS-PLATFORM - BOTH type: string authenticatorSelectionRequireResidentKey: description: "Flag used to indicate authenticator selection is required or not\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean authenticatorSelectionResidentKey: description: "Attribute used to define authenticator selection resident key requirement.\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - REQUIRED - PREFERRED - DISCOURAGED - NONE type: string authenticatorSelectionUserVerification: description: "Attribute used to define authenticator selection verification.\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - REQUIRED - PREFERRED - DISCOURAGED type: string domainValidationLevel: description: "Number of domain levels Oracle Identity Cloud Service should use for origin comparision\n\n**Added In:** 2109020413\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - idcsMaxValue: 2\n - idcsMinValue: 0\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer excludeCredentials: description: "Flag used to indicate whether we need to restrict creation of multiple credentials in same authenticator\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean publicKeyTypes: description: "List of server supported public key algorithms\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: enum: - RS1 - RS256 - ES256 type: string type: array timeout: description: "Timeout for the fido authentication to complete\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - idcsMaxValue: 600000\n - idcsMinValue: 10000\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer required: - attestation - authenticatorSelectionAttachment - authenticatorSelectionUserVerification - authenticatorSelectionResidentKey - timeout - authenticatorSelectionRequireResidentKey - publicKeyTypes - excludeCredentials type: object ExtensionUserUser: description: Oracle Identity Cloud Service User properties: accountRecoveryRequired: description: "Boolean value to prompt user to setup account recovery during login.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean accounts: description: "Accounts assigned to this User. Each value of this attribute refers to an app-specific identity that is owned by this User. Therefore, this attribute is a convenience that allows one to see on each User the Apps to which that User has access.\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtAccounts' type: array appRoles: description: "A list of all AppRoles to which this User belongs directly, indirectly or implicitly. The User could belong directly because the User is a member of the AppRole, could belong indirectly because the User is a member of a Group that is a member of the AppRole, or could belong implicitly because the AppRole is public.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtAppRoles' type: array applicableAuthenticationTargetApp: $ref: '#/components/schemas/UserExtApplicableAuthenticationTargetApp' bypassNotification: description: "A Boolean value indicating whether or not to send email notification after creating the user. This attribute is not used in update/replace operations.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeNameMappings: [[columnHeaderName:ByPass Notification]]\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean creationMechanism: description: "User creation mechanism\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeNameMappings: [[defaultValue:import]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" enum: - bulk - api - adsync - idcsui - import - authsync - selfreg - samljit type: string delegatedAuthenticationTargetApp: $ref: '#/components/schemas/UserExtDelegatedAuthenticationTargetApp' doNotShowGettingStarted: description: "A Boolean value indicating whether or not to hide the getting started page\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean grants: description: "Grants to this User. Each value of this attribute refers to a Grant to this User of some App (and optionally of some entitlement). Therefore, this attribute is a convenience that allows one to see on each User all of the Grants to that User.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtGrants' type: array groupMembershipLastModified: description: "Specifies date time when a User's group membership was last modified.\n\n**Added In:** 2304270343\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string idcsAppRolesLimitedToGroups: description: "Description:\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, idcsAppRoleId]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n" items: $ref: '#/components/schemas/UserExtIdcsAppRolesLimitedToGroups' type: array isAccountRecoveryEnrolled: description: "A Boolean value indicating whether or not a user is enrolled for account recovery\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean isAuthenticationDelegated: description: "A Boolean value indicating whether or not authentication request by this user should be delegated to a remote app. This value should be true only when the User was originally synced from an app which is enabled for delegated authentication\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean isFederatedUser: description: "A Boolean value indicating whether or not the user is federated.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Federated\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Federated]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isGroupMembershipNormalized: description: "A Boolean value indicating whether or not group membership is normalized for this user.\n\n**Deprecated Since: 19.3.3**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean isGroupMembershipSyncedToUsersGroups: description: "A Boolean value Indicates whether this User's group membership has been sync'ed from Group.members to UsersGroups.\n\n**Added In:** 19.3.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean notificationEmailTemplateId: description: "Specifies the EmailTemplate to be used when sending notification to the user this request is for. If specified, it overrides the default EmailTemplate for this event.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" type: string preferredUiLandingPage: description: "User's preferred landing page following login, logout and reset password.\n\n**Added In:** 2302092332\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - MyApps - MyProfile - OciConsole maxLength: 40 type: string provider: description: "Registration provider\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - facebook - google - IDCS - twitter type: string serviceUser: description: "Indicates if User is a Service User\n\n**Added In:** 2306131901\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Service User\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Service User]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean status: description: "A supplemental status indicating the reason why a user is disabled\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" enum: - pendingVerification - verified type: string supportAccounts: description: "A list of Support Accounts corresponding to user.\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtSupportAccounts' type: array syncedFromApp: $ref: '#/components/schemas/UserExtSyncedFromApp' userFlowControlledByExternalClient: description: "A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean userToken: $ref: '#/components/schemas/UserExtUserToken' type: object UserExtTrustedUserAgents: description: "A list of trusted User Agents owned by this user. Multi-Factored Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests. For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, oneof several executing on a particular mobile device). A User Agent is trusted once the Multi-Factor Authentication has verified it in some way.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding trusted user agent resource.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human-readable identifier for this trusted user agent, used primarily for display purposes. READ-ONLY.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The user's trusted user agent identifier.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object RuleExtensionOciconsolesignonpolicyconsentPolicy: description: This extension defines attributes used to record consent for modification of the "Security Policy for OCI Console" sign-on policy, Rule, Condition or ConditionGroup. properties: consent: description: "Set to true when an identity domain administrator opts to change the Oracle security defaults for the \"Security Policy for OCI Console\" shipped by Oracle. Defaults to false.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: boolean" type: boolean justification: description: "The justification for the change when an identity domain administrator opts to modify the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string" type: string reason: description: "The detailed reason for the change when an identity domain administrator opts to modify the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string" maxLength: 250 minLength: 5 type: string type: object meta: description: "A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]\n - type: complex" properties: created: description: "The DateTime the Resource was added to the Service Provider\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string lastModified: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string location: description: "The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string resourceType: description: "Name of the resource type of the resource--for example, Users or Groups\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string version: description: "The version of the Resource being returned. This value must be the same as the ETag HTTP response header.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object AppCloudControlProperties: description: A collection of arbitrary properties that scope the privileges of a cloud-control App. properties: name: description: "The name of the property.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string values: description: "The value(s) of the property.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array required: - name - values type: object UserAttributesSettings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/UserAttributesSetting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object SocialIdentityProviders: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/SocialIdentityProvider' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AccountMgmtInfoObjectClass: description: "Object-class of the Account\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Object-class URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Object-class display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Object-class Identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object GroupMembers: description: 'The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use ''startIndex'' and ''count'' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.' properties: $ref: description: "The URI that corresponds to the member Resource of this group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string dateAdded: description: "The date and time that the member was added to the group.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string display: description: "The member's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string membershipOcid: description: "The membership OCID.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 type: string name: description: "The member's name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the member of this group.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string type: description: "Indicates the type of resource, for example, User or Group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - idcsDefaultValue: User\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - User maxLength: 10 type: string value: description: "The ID of the member of this Group\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value - type type: object PatchOp: description: See [Section 3.5.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.5.2). HTTP PATCH is an OPTIONAL server function that enables clients to update one or more attributes of a SCIM resource using a sequence of operations to "add", "remove", or "replace" values. Clients may discover service provider support for PATCH by querying the service provider configuration. The general form of the SCIM patch request is based on JavaScript Object Notation (JSON) Patch [RFC6902]. One difference between SCIM patch and JSON patch is that SCIM servers do not support array indexing and do not support [RFC6902] operation types relating to array element manipulation such as "move". A patch request, regardless of the number of operations, SHALL be treated as atomic. If a single operation encounters an error condition, the original SCIM resource MUST be restored, and a failure status SHALL be returned. properties: Operations: description: The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations. items: $ref: '#/components/schemas/Operations' type: array schemas: description: 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. 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. REQUIRED. items: type: string type: array required: - schemas - Operations type: object ExtensionDbcsGroup: description: Schema for Database Service Resource properties: domainLevelSchema: description: "DBCS Domain-level schema-name. This attribute refers implicitly to a value of 'domainLevelSchemaNames' for a particular DB Domain.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string domainLevelSchemaNames: description: "DBCS Domain-level schema-names. Each value is specific to a DB Domain.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [domainName, schemaName]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex" items: $ref: '#/components/schemas/GroupExtDomainLevelSchemaNames' type: array instanceLevelSchema: description: "DBCS instance-level schema-name. This attribute refers implicitly to a value of 'instanceLevelSchemaNames' for a particular DB Instance.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string instanceLevelSchemaNames: description: "DBCS instance-level schema-names. Each schema-name is specific to a DB Instance.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [dbInstanceId, schemaName]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex" items: $ref: '#/components/schemas/GroupExtInstanceLevelSchemaNames' type: array type: object PasswordPolicy: description: PasswordPolicy resource. properties: allowedChars: description: "A String value whose contents indicate a set of characters that can appear, in any sequence, in a password value\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string configuredPasswordPolicyRules: description: "List of password policy rules that have values set. This map of stringKey:stringValue pairs can be used to aid users while setting/resetting password\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [key]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/PasswordPolicyConfiguredPasswordPolicyRules' type: array deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "A String that describes the password policy\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 type: string dictionaryDelimiter: description: "A delimiter used to separate characters in the dictionary file\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string dictionaryLocation: description: "A Reference value that contains the URI of a dictionary of words not allowed to appear within a password value\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string dictionaryWordDisallowed: description: "Indicates whether the password can match a dictionary word\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean disallowedChars: description: "A String value whose contents indicate a set of characters that cannot appear, in any sequence, in a password value\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string disallowedSubstrings: description: "A String value whose contents indicate a set of substrings that cannot appear, in any sequence, in a password value\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array disallowedUserAttributeValues: description: "List of User attributes whose values are not allowed in the password.\n\n**Added In:** 2303212224\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 500 minLength: 1 type: array distinctCharacters: description: "The number of distinct characters between old password and new password\n\n**Added In:** 2303212224\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string firstNameDisallowed: description: "Indicates a sequence of characters that match the user's first name of given name cannot be the password. Password validation against policy will be ignored if length of first name is less than or equal to 3 characters.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean forcePasswordReset: description: "Indicates whether all of the users should be forced to reset their password on the next login (to comply with new password policy changes)\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean groups: description: "A list of groups that the password policy belongs to.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/PasswordPolicyGroups' type: array id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array lastNameDisallowed: description: "Indicates a sequence of characters that match the user's last name of given name cannot be the password. Password validation against policy will be ignored if length of last name is less than or equal to 3 characters.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean lockoutDuration: description: "The time period in minutes to lock out a user account when the threshold of invalid login attempts is reached. The available range is from 5 through 1440 minutes (24 hours).\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxIncorrectAttempts: description: "An integer that represents the maximum number of failed logins before an account is locked\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxLength: description: "The maximum password length (in characters). A value of 0 or no value indicates no maximum length restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxRepeatedChars: description: "The maximum number of repeated characters allowed in a password. A value of 0 or no value indicates no such restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxSpecialChars: description: "The maximum number of special characters in a password. A value of 0 or no value indicates no maximum special characters restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer meta: $ref: '#/components/schemas/meta' minAlphaNumerals: description: "The minimum number of a combination of alphabetic and numeric characters in a password. A value of 0 or no value indicates no minimum alphanumeric character restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minAlphas: description: "The minimum number of alphabetic characters in a password. A value of 0 or no value indicates no minimum alphas restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minLength: description: "The minimum password length (in characters). A value of 0 or no value indicates no minimum length restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minLowerCase: description: "The minimum number of lowercase alphabetic characters in a password. A value of 0 or no value indicates no minimum lowercase restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minNumerals: description: "The minimum number of numeric characters in a password. A value of 0 or no value indicates no minimum numeric character restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minPasswordAge: description: "Minimum time after which the user can resubmit the reset password request\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minSpecialChars: description: "The minimum number of special characters in a password. A value of 0 or no value indicates no minimum special characters restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minUniqueChars: description: "The minimum number of unique characters in a password. A value of 0 or no value indicates no minimum unique characters restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minUpperCase: description: "The minimum number of uppercase alphabetic characters in a password. A value of 0 or no value indicates no minimum uppercase restriction.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer name: description: "A String that is the name of the policy to display to the user. This is the only mandatory attribute for a password policy.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: server" maxLength: 100 minLength: 1 type: string numPasswordsInHistory: description: "The number of passwords that will be kept in history that may not be used as a password\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string passwordExpireWarning: description: "An integer indicating the number of days before which the user should be warned about password expiry.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer passwordExpiresAfter: description: "The number of days after which the password expires automatically\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer passwordStrength: description: "Indicates whether the password policy is configured as Simple, Standard, or Custom.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Simple - Standard - Custom type: string priority: description: "Password policy priority\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - idcsMinValue: 1\n - uniqueness: server" type: integer requiredChars: description: "A String value whose contents indicate a set of characters that must appear, in any sequence, in a password value\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array startsWithAlphabet: description: "Indicates that the password must begin with an alphabetic character\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string userNameDisallowed: description: "Indicates a sequence of characters that match the username cannot be the password. Password validation against policy will be ignored if length of user name is less than or equal to 3 characters.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - schemas - name type: object AppAllowedScopes: description: A list of scopes (exposed by this App or by other Apps) that this App is allowed to access when it acts as an OAuthClient. properties: fqs: description: "A fully qualified scope that this App is allowed to access when it acts as an OAuthClient.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idOfDefiningApp: description: "The ID of the App that defines this scope.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string readOnly: description: "If true, indicates that this value must be protected.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - fqs type: object AppExtensionManagedappApp: description: Managed App properties: accountFormVisible: description: "If true, then the account form will be displayed in the Oracle Identity Cloud Service UI to interactively create or update an account for this App. If a value is not specified for this attribute, a default value of \\\"false\\\" will be assumed as the value for this attribute.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean adminConsentGranted: description: "If true, admin has granted consent to perform managed app run-time operations.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean bundleConfigurationProperties: description: "ConnectorBundle configuration properties\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppBundleConfigurationProperties' type: array bundlePoolConfiguration: $ref: '#/components/schemas/AppBundlePoolConfiguration' canBeAuthoritative: description: "If true, the managed app can be authoritative.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean connected: description: "If true, the accounts of the application are managed through an ICF connector bundle\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean connectorBundle: $ref: '#/components/schemas/AppConnectorBundle' enableAuthSyncNewUserNotification: description: "If true, send activation email to new users created from authoritative sync.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean enableSync: description: "If true, sync run-time operations are enabled for this App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean enableSyncSummaryReportNotification: description: "If true, send sync summary as notification upon job completion.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean flatFileBundleConfigurationProperties: description: "Flat file connector bundle configuration properties\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppFlatFileBundleConfigurationProperties' type: array flatFileConnectorBundle: $ref: '#/components/schemas/AppFlatFileConnectorBundle' identityBridges: description: "IdentityBridges associated with this App\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppIdentityBridges' type: array isAuthoritative: description: "If true, sync from the managed app will be performed as authoritative sync.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isDirectory: description: "If true, the managed app is a directory.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isOnPremiseApp: description: "If true, the managed app is an On-Premise app.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isSchemaCustomizationSupported: description: "If true, the managed app supports schema customization.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isSchemaDiscoverySupported: description: "If true, the managed app supports schema discovery.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isThreeLeggedOAuthEnabled: description: "If true, the managed app requires 3-legged OAuth for authorization.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isTwoLeggedOAuthEnabled: description: "If true, indicates that Oracle Identity Cloud Service can use two-legged OAuth to connect to this ManagedApp.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean objectClasses: description: "Object classes\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppObjectClasses' type: array syncConfigLastModified: description: "The most recent DateTime that the configuration of this App was updated. AppServices updates this timestamp whenever AppServices updates an App's configuration with respect to synchronization.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string threeLeggedOAuthCredential: $ref: '#/components/schemas/AppThreeLeggedOAuthCredential' threeLeggedOAuthProviderName: description: "Three legged OAuth provider name in Oracle Identity Cloud Service.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string" type: string type: object OAuth2ClientCredentialUser: description: "The user linked to the OAuth2 client credential.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The username.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object SocialIdentityProviderRelayIdpParamMappings: description: Relay Param variable for Social IDP properties: relayParamKey: description: "Key or name of the relayParam.\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string relayParamValue: description: "Value of the relayParam (if defined)\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string required: - relayParamKey type: object MyOAuth2ClientCredentialScopes: description: Scopes properties: audience: description: "Audience\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: true\n - returned: default" maxLength: 200 type: string scope: description: "Scope\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsScimCompliant: false\n - type: string\n - mutability: readWrite\n - multiValued: false\n - required: true\n - returned: default" maxLength: 100 type: string required: - audience - scope type: object UserDbCredentialsUser: description: "The user linked to the database credential.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The username.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's identifier.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object MyApiKey: description: The user's API key. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**Added In:** 2101262133\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string fingerprint: description: "Fingerprint\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - type: string\n - mutability: readOnly\n - required: true\n - returned: default" maxLength: 4000 type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array key: description: "Key\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsPii: true\n - type: string\n - mutability: immutable\n - required: true\n - returned: default" maxLength: 4000 type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string user: $ref: '#/components/schemas/MyApiKeyUser' required: - schemas - fingerprint - key type: object OAuthPartnerCertificate: description: OAuth Partner Certificate schema properties: certEndDate: description: "Certificate end date\n\n**SCIM++ Properties:**\n - type: dateTime\n - multiValued: false\n - required: false\n - caseExact: true\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string certStartDate: description: "Certificate start date\n\n**SCIM++ Properties:**\n - type: dateTime\n - multiValued: false\n - required: false\n - caseExact: true\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string certificateAlias: description: "Certificate alias\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: true\n - caseExact: false\n - mutability: readWrite\n - returned: always\n - uniqueness: none\n - idcsSearchable: true" maxLength: 255 minLength: 1 type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array keyStoreId: description: "Key store ID\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: true\n - returned: never\n - uniqueness: none\n - idcsSearchable: true" type: string keyStoreName: description: "Key store name\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: false\n - returned: always\n - uniqueness: none" maxLength: 255 minLength: 1 type: string keyStorePassword: description: "Key store password\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - idcsSensitive: none\n - required: false\n - caseExact: true\n - returned: never\n - uniqueness: none" maxLength: 255 minLength: 1 type: string map: description: "Map\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: false\n - returned: always\n - uniqueness: none" maxLength: 255 minLength: 1 type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array sha1Thumbprint: description: "SHA-1 Thumbprint\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: true\n - returned: default\n - idcsSearchable: true\n - uniqueness: none" type: string sha256Thumbprint: description: "SHA-256 Thumbprint\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: true\n - returned: default\n - idcsSearchable: true\n - uniqueness: none" type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string x509Base64Certificate: description: "Base 64Key data attribute\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 2048 type: string required: - schemas - certificateAlias type: object ResourceTypeSchemaAttribute: description: ResourceTypeSchemaAttribute Schema Definition properties: canonicalValues: description: "A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \\\"work\\\", \\\"home\\\".\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array caseExact: description: "Specifies if the String attribute is case-sensitive\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "The attribute's human-readable description\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - idcsSearchable: true\n - type: string\n - uniqueness: none" type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string endUserMutability: description: "Specifies User mutability for this attribute\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - readOnly - readWrite - immutable - hidden type: string endUserMutabilityAllowedValues: description: "Specifies the list of User mutabilities allowed\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: enum: - readOnly - readWrite - immutable - hidden type: string type: array id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsAddedSinceReleaseNumber: description: "Indicates that the schema has been added since this release number\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: string" type: string idcsAddedSinceVersion: description: "Indicates that the schema has been added since version\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: integer" type: integer idcsAttributeCacheable: description: "Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \\\"attributesToGet\\\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsAttributeMappable: description: "Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP. If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean idcsAuditable: description: "Specifies whether changes to this attribute value are audited\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsAutoIncrementSeqName: description: "Sequence tracking ID name for the attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string" maxLength: 8 type: string idcsCanonicalValueSourceFilter: description: "Filter to use when getting canonical values for this schema attribute\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceResourceType: description: "Specifies the Resource type to read from for dynamic canonical values\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCompositeKey: description: "The set of one or more sub attributes' names of a CMVA, whose values uniquely identify an instance of a CMVA\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsCsvColumnHeaderName: description: "The attribute defining the CSV column header name for import/export\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCustomAttribute: description: "custom attribute flag.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - idcsSearchable: true\n - uniqueness: none" type: boolean idcsDeprecatedSinceReleaseNumber: description: "Indicates that the schema has been deprecated since this release number\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: string" type: string idcsDeprecatedSinceVersion: description: "Indicates that the schema has been deprecated since version\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: integer" type: integer idcsDisplayName: description: "Specifies the user-friendly displayable attribute name or catalog key used for localization\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - idcsSearchable: true\n - type: string\n - uniqueness: none" type: string idcsDisplayNameMessageId: description: "Localized schema attribute display name for use by UI client for displaying attribute labels\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - idcsSearchable: true\n - type: string\n - uniqueness: none" type: string idcsFetchComplexAttributeValues: description: '**SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readOnly - required: false - idcsSearchable: true - returned: default - type: boolean - uniqueness: none Whether the CMVA attribute will be fetched or not for current resource in AbstractResourceManager update operation before calling data provider update. Default is true. ' type: boolean idcsFromTargetMapper: description: "Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsFullyQualifiedName: description: "Fully qualified name of this attribute\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - idcsSearchable: true\n - uniqueness: none" type: string idcsGenerated: description: "Specifies whether this attribute value was generated\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean idcsICFAttributeType: description: "Maps to ICF data type\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - string - long - char - double - float - integer - boolean - bytes - bigdecimal - biginteger - guardedbytes - guardedstring type: string idcsICFBundleAttributeName: description: "Maps to ICF target attribute name\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsICFRequired: description: "Metadata to identify the ICF required attribute\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsIndirectRefResourceAttributes: description: "Specifies the indirectly referenced Resources\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string" items: type: string type: array idcsInternal: description: "Specifies whether the schema attribute is for internal use only. Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internalflag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsMaxLength: description: "Specifies the maximum length of the attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: integer" type: integer idcsMaxValue: description: "Specifies the maximum value of the integer attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: integer" type: integer idcsMinLength: description: "Specifies the minimum length of the attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: integer" type: integer idcsMinValue: description: "Specifies the minimum value of the integer attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: integer" type: integer idcsMultiLanguage: description: "If true, specifies that the attribute can have multiple language values set for the attribute on which this is set.\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array idcsRefResourceAttribute: description: "Specifies the referenced Resource attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: string" type: string idcsRefResourceAttributes: description: "Specifies the directly referenced Resources\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string" items: type: string type: array idcsSchemaUrn: description: "Schema URN string that this attribute belongs to\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - idcsSearchable: true\n - uniqueness: none" type: string idcsScimCompliant: description: "Indicates if the attribute is scim compliant, default is true\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - idcsSearchable: true\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsSearchable: description: "Specifies whether this attribute can be included in a search filter\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean idcsSensitive: description: "Flag to specify if the attribute should be encrypted or hashed\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - encrypt - hash - hash_sc - checksum - none type: string idcsTargetAttributeName: description: "Target attribute name that this attribute gets mapped to for persistence\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetAttributeNameToMigrateFrom: description: "Old Target attribute name from child table for CSVA attribute prior to migration. This maintains this attribute used to get mapped to for persistence\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetNormAttributeName: description: "Target normalized attribute name that this normalized value of attribute gets mapped to for persistence. Only set for caseExact=false & searchable attributes. Do not use by default.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetUniqueConstraintName: description: "Target index name created for this attribute for performance\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsToTargetMapper: description: "Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTrimStringValue: description: "Trims any leading and trailing blanks from String values. Default is True.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean idcsValidateReference: description: "Validate payload reference value during create, replace, and update. Default is True.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsValuePersisted: description: "Specifies whether the value of the Resource attribute is persisted\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean meta: $ref: '#/components/schemas/meta' multiValued: description: "Indicates the attribute's plurality\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean mutability: description: "Specifies if the attribute is mutable\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - idcsSearchable: true\n - type: string\n - uniqueness: none" enum: - readOnly - readWrite - immutable - writeOnly type: string name: description: "Attribute's name\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - idcsSearchable: true\n - type: string\n - uniqueness: none" type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string referenceTypes: description: "The names of the Resource types that may be referenced--for example, User. This is only applicable for attributes that are of the \\\"reference\\\" data type.\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array required: description: "Specifies if the attribute is required\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: boolean" type: boolean resourceType: description: "ResourceType this attribute belongs to.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - idcsSearchable: true\n - uniqueness: none" type: string returned: description: "A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - idcsSearchable: true\n - type: string\n - uniqueness: none" enum: - always - never - default - request type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "The attribute's data type--for example, String\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - idcsSearchable: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - string - complex - boolean - decimal - integer - dateTime - reference - binary type: string uniqueness: description: "A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has the uniqueness of \\\"none\\\".\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - required: false\n - returned: default\n - idcsSearchable: true\n - type: string\n - uniqueness: none" enum: - none - server - global type: string required: - schemas type: object MyAuthenticationFactorValidatorSecurityQuestions: description: List of security questions the user has submitted to get authenticated. properties: answer: description: "Answer of the security question the user has submitted\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsSensitive: none" type: string id: description: "id of the security question\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - id type: object SelfRegistrationProfileSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MySmtpCredentialUser: description: "User linked to smtp credential\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "User name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "User's ocid\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "User's id\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object Rules: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/Rule' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object IdentitySettingsTokens: description: A list of tokens and their expiry length. properties: expiresAfter: description: "Indicates the number of minutes after which the token expires automatically.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer type: description: "The token type.\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - emailVerification - passwordReset - createUser type: string required: - type type: object AppTermsOfUse: description: "Terms Of Use.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "URI of the TermsOfUse.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string name: description: "Terms Of Use name\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string value: description: "Identifier of the TermsOfUse\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object OAuthClientCertificates: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/OAuthClientCertificate' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object GrantAppEntitlementCollection: description: "Application-Entitlement-Collection that is being granted. Each Grant must grant either an App or an App-Entitlement-Collection.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Application Entitlement Collection URI\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Application Entitlement Collection identifier\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object SecurityQuestionSettingsSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array required: - schemas type: object UserExtDbCredentials: description: "A list of database credentials corresponding to user.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding UserDbCredential resource to which the user belongs.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ocid: description: "The user's database credential OCID.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "The user's database credential identifier.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object ApprovalWorkflowAssignmentAssignedTo: description: "Details of resource for which Approval Workflow is assigned\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: description: description: "Description\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string display: description: "Display name of the resource for which Approval Workflow is assigned\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string ocid: description: "Ocid of the resource for which Approval Workflow is assigned\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string type: description: "Type of the resource (stripe and non-stripe) for which Approval Workflow is assigned\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" enum: - Group maxLength: 40 type: string value: description: "Identifier of the resource for which Approval Workflow is assigned\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value - type type: object IdentityProviderCorrelationPolicy: description: "Correlation policy\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Policy URI\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Policy display name\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "A label that indicates the type that this references.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsDefaultValue: Policy\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - Policy maxLength: 40 type: string value: description: "Policy identifier\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - type - value type: object MyDeviceAdditionalAttributes: description: Device additional attributes properties: key: description: "Device Attribute Key Name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 100 minLength: 1 type: string value: description: "Device Attribute Value\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 100 minLength: 1 type: string required: - key - value type: object SecurityQuestionSettings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/SecurityQuestionSetting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyAuthTokenUser: description: "The user linked to the Auth token.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The username.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object SelfRegistrationProfileAfterSubmitText: description: Text to be displayed on UI after doing self registration properties: default: description: "If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean locale: description: "Type of user's locale e.g. en-CA\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(type)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Localized value of after submit text in corresponding locale\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string required: - locale - value type: object UserExtApplicableAuthenticationTargetApp: description: "The app against which the user will authenticate. The value is not persisted but rather calculated. If the user's delegatedAuthenticationTargetApp is set, that value is returned. Otherwise, the app returned by evaluating the user's applicable Delegated Authentication Policy is returned.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "App URI\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "App Display Name\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string targetRequestTimeout: description: "Timeout interval for Synchronization TargetAction in milliseconds\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer type: description: "A label that indicates whether this is an App or IdentitySource.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "App identifier\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - type type: object OAuthClientCertificate: description: OAuth Client Certificate schema properties: certEndDate: description: "Certificate end date\n\n**SCIM++ Properties:**\n - type: dateTime\n - multiValued: false\n - required: false\n - caseExact: true\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string certStartDate: description: "Certificate start date\n\n**SCIM++ Properties:**\n - type: dateTime\n - multiValued: false\n - required: false\n - caseExact: true\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string certificateAlias: description: "Certificate alias\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: true\n - caseExact: false\n - mutability: readWrite\n - returned: always\n - uniqueness: none\n - idcsSearchable: true" maxLength: 255 minLength: 1 type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array keyStoreId: description: "Key store ID\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: true\n - returned: never\n - uniqueness: none\n - idcsSearchable: true" type: string keyStoreName: description: "Key store name\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: false\n - returned: always\n - uniqueness: none" maxLength: 255 minLength: 1 type: string keyStorePassword: description: "Key store password\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - idcsSensitive: none\n - required: false\n - caseExact: true\n - returned: never\n - uniqueness: none" maxLength: 255 minLength: 1 type: string map: description: "Map\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - caseExact: false\n - returned: always\n - uniqueness: none" maxLength: 255 minLength: 1 type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array sha1Thumbprint: description: "SHA-1 Thumbprint\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - idcsSearchable: true\n - required: false\n - caseExact: true\n - returned: default\n - uniqueness: none" type: string sha256Thumbprint: description: "SHA-256 Thumbprint\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - idcsSearchable: true\n - required: false\n - caseExact: true\n - returned: default\n - uniqueness: none" type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string x509Base64Certificate: description: "Base 64Key data attribute\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - certificateAlias - x509Base64Certificate type: object MyGroupMembers: description: 'The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use ''startIndex'' and ''count'' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.' properties: $ref: description: "The URI that corresponds to the member Resource of this group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string dateAdded: description: "The date and time that the member was added to the group.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string display: description: "The member's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string membershipOcid: description: "The membership OCID.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 type: string name: description: "The member's name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the member of this group.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string type: description: "Indicates the type of resource, for example, User or Group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - idcsDefaultValue: User\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - User maxLength: 10 type: string value: description: "The ID of the member of this Group\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value - type type: object Grant: description: Schema for Grant Resource properties: app: $ref: '#/components/schemas/GrantApp' appEntitlementCollection: $ref: '#/components/schemas/GrantAppEntitlementCollection' compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string compositeKey: description: "Unique key of grant, composed by combining a subset of app, entitlement, grantee, grantor and grantMechanism. Used to prevent duplicate Grants.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: server" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string entitlement: $ref: '#/components/schemas/GrantEntitlement' grantMechanism: description: "Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.\nA customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR':\n - 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User.\n - 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group.\n - 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeNameMappings: [[defaultValue:IMPORT_GRANTS]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - IMPORT_APPROLE_MEMBERS - ADMINISTRATOR_TO_USER - ADMINISTRATOR_TO_DELEGATED_USER - ADMINISTRATOR_TO_GROUP - SERVICE_MANAGER_TO_USER - ADMINISTRATOR_TO_APP - SERVICE_MANAGER_TO_APP - OPC_INFRA_TO_APP - GROUP_MEMBERSHIP - IMPORT_GRANTS - SYNC_TO_USER - ACCESS_REQUEST - APP_ENTITLEMENT_COLLECTION - ADMINISTRATOR_TO_DYNAMIC_RESOURCE_GROUP type: string grantedAttributeValuesJson: description: "Store granted attribute-values as a string in Javascript Object Notation (JSON) format.\n\n**Added In:** 18.3.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100000 minLength: 1 type: string grantee: $ref: '#/components/schemas/GrantGrantee' grantor: $ref: '#/components/schemas/GrantGrantor' id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isFulfilled: description: "If true, this Grant has been fulfilled successfully.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - grantMechanism - grantee type: object MyAppOwner: description: "Owning user of the account\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "User URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "User Identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object ExtensionPosixUser: description: POSIX User extension properties: gecos: description: "General information about the POSIX account such as their real name and phone number\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string gidNumber: description: "Primary Group identifier of the POSIX user\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: integer\n - uniqueness: none" type: integer homeDirectory: description: "The absolute path to the home directory of the POSIX account\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string loginShell: description: "The path to the login shell of the POSIX account\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string uidNumber: description: "Integer uniquely identifying a user in a POSIX administrative domain\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: integer\n - uniqueness: server" type: integer type: object NetworkPerimeterIpAddresses: description: IPAddresses or Ranges assigned to the NetworkPerimeter properties: type: description: "type of the ip address value\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - CIDR - RANGE - EXACT maxLength: 40 type: string value: description: "Value of exact ipaddress or the range in CIDR or the range with start and end ip addresses\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string version: description: "Indicates the type of Ip Address example, IPV4 or IPV6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - IPV4 - IPV6 type: string required: - value type: object MyDeviceUser: description: "Device member\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the member Resource of this device\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" type: string display: description: "User display name\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the user\n\n**Added In:** 2105091740\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 400 minLength: 1 type: string value: description: "The identifier of the user\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 40 minLength: 1 type: string required: - value type: object UserExtSecQuestions: description: "The schema used to mnage security question and answers provided by a user for account recovery and/or MFA. While setting up security questions, a user can also provide a hint for the answer.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding Security Question resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string answer: description: "The answer provided by a user for a security question.\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Answer\n - idcsSearchable: false\n - idcsSensitive: hash\n - multiValued: false\n - mutability: writeOnly\n - required: true\n - returned: never\n - type: string\n - uniqueness: none\n - idcsPii: true" minLength: 1 type: string hintText: description: "The hint for an answer that's given by user when setting up a security question.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The identifier of the question selected by the user when setting up a security question.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value - answer type: object Policies: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/Policy' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyAuthenticationFactorsRemoverUser: description: "User for whom the authentication factors need to be deleted\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the member Resource for whom the factors will be deleted\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the user\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 400 minLength: 1 type: string value: description: "The identifier of the user\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value type: object ApprovalWorkflowAssignment: description: Schema for ApprovalWorkflowAssignment properties: approvalWorkflow: $ref: '#/components/schemas/ApprovalWorkflowAssignmentApprovalWorkflow' assignedTo: $ref: '#/components/schemas/ApprovalWorkflowAssignmentAssignedTo' assignmentType: description: "Type of approval workflow assignment to the resource. Resources like Group have only one workflow associated (default assignment type is membership), but resources like TemporalBusinessRole can have atleast 2 AWs attached, one for membership to TPR, another for activation of that TPR membership\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - MEMBERSHIP - ACTIVATION maxLength: 40 type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - assignmentType - approvalWorkflow - assignedTo type: object UserEmails: description: A complex attribute representing emails properties: pendingVerificationData: description: "Pending e-mail address verification\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string primary: description: "A Boolean value that indicates whether the email address is the primary email address. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean secondary: description: "A Boolean value that indicates whether the email address is the secondary email address. The secondary attribute value 'true' MUST appear no more than once.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "Type of email address\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - work - home - other - recovery type: string value: description: "Email address\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 5 type: string verified: description: "A Boolean value that indicates whether or not the e-mail address is verified\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - value - type type: object SchemaSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object ExtensionDbUserUser: description: DB User extension properties: dbGlobalRoles: description: "DB global roles to which the user is granted access.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: type: string type: array domainLevelSchema: description: "DB domain level schema to which the user is granted access.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string instanceLevelSchema: description: "DB instance level schema to which the user is granted access.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string isDbUser: description: "If true, indicates this is a database user.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean passwordVerifiers: description: "Password Verifiers for DB User.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [type]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtPasswordVerifiers' type: array type: object GroupSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MeName: description: "A complex attribute that contains attributes representing the name\n\n**SCIM++ Properties:**\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Formatted Name, mapsTo:name.formatted], [columnHeaderName:Honorific Prefix, mapsTo:name.honorificPrefix], [columnHeaderName:First Name, mapsTo:name.givenName], [columnHeaderName:Middle Name, mapsTo:name.middleName], [columnHeaderName:Last Name, mapsTo:name.familyName], [columnHeaderName:Honorific Suffix, mapsTo:name.honorificSuffix]]\n - idcsPii: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: familyName: description: "Last name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Last Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 150 minLength: 1 type: string formatted: description: "Full name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 354 minLength: 1 type: string givenName: description: "First name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: First Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 150 minLength: 1 type: string honorificPrefix: description: "Prefix\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Honorific Prefix\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 25 minLength: 1 type: string honorificSuffix: description: "Suffix\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Honorific Suffix\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 25 minLength: 1 type: string middleName: description: "Middle name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Middle Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string type: object UserEntitlements: description: A list of entitlements for the User that represent a thing the User has. properties: display: description: "A human readable name, primarily used for display purposes.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label indicating the attribute's function.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The value of an entitlement.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string required: - value - type type: object MyUserDbCredential: description: User's Database Credential properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string dbPassword: description: "The user's database password.\n\n**SCIM++ Properties:**\n - type: string\n - mutability: immutable\n - returned: default\n - required: true" maxLength: 128 minLength: 1 type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**Added In:** 2109020413\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expired: description: "Indicates that the database password has expired.\n\n**SCIM++ Properties:**\n - type: boolean\n - mutability: readOnly\n - returned: default" type: boolean expiresOn: description: "When the user credential expires.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array lastSetDate: description: "A DateTime that specifies the date and time when the current database password was set.\n\n**SCIM++ Properties:**\n - type: dateTime\n - mutability: readOnly\n - returned: default" type: string meta: $ref: '#/components/schemas/meta' mixedDbPassword: description: "The user's database password with mixed salt.\n\n**SCIM++ Properties:**\n - type: string\n - mutability: readOnly\n - returned: default\n - required: false" maxLength: 128 minLength: 12 type: string mixedSalt: description: "The mixed salt of the password.\n\n**SCIM++ Properties:**\n - type: string\n - mutability: readOnly\n - returned: default\n - required: false" maxLength: 128 minLength: 12 type: string name: description: "Name\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readOnly\n - required: false\n - returned: default" maxLength: 100 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string salt: description: "The salt of the password.\n\n**SCIM++ Properties:**\n - type: string\n - mutability: readOnly\n - returned: default\n - required: false" maxLength: 128 minLength: 12 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "User credential status\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string user: $ref: '#/components/schemas/MyUserDbCredentialsUser' required: - schemas - dbPassword type: object Setting: description: Settings schema properties: accountAlwaysTrustScope: description: "Indicates whether all the Apps in this customer tenancy should trust each other. A value of true overrides the 'defaultTrustScope' attribute here in Settings, as well as any App-specific 'trustScope' attribute, to force in effect 'trustScope=Account' for every App in this customer tenancy.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean allowedDomains: description: "One or more email domains allowed in a user's email field. If unassigned, any domain is allowed.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array allowedForgotPasswordFlowReturnUrls: description: "If specified, indicates the set of Urls which can be returned to after successful forgot password flow\n\n**Added In:** 19.3.3\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: true\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - caseExact: false" items: type: string type: array allowedNotificationRedirectUrls: description: "If specified, indicates the set of allowed notification redirect Urls which can be specified as the value of \\\"notificationRedirectUrl\\\" in the POST .../admin/v1/MePasswordResetRequestor request payload, which will then be included in the reset password email notification sent to a user as part of the forgot password / password reset flow.\n\n**Added In:** 2009041201\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: true\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - caseExact: false" items: type: string type: array auditEventRetentionPeriod: description: "Audit Event retention period. If set, overrides default of 30 days after which Audit Events will be purged\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" enum: - 30 - 60 - 90 type: integer certificateValidation: $ref: '#/components/schemas/SettingsCertificateValidation' cloudAccountName: description: "The attribute to store the cloud account name\n\n**Deprecated Since: 2011192329**\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string cloudGateCorsSettings: $ref: '#/components/schemas/SettingsCloudGateCorsSettings' cloudMigrationCustomUrl: description: "If specified, indicates the custom SIM Migrator Url which can be used while SIM to Oracle Identity Cloud Service CloudAccount Migration.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - caseExact: false" type: string cloudMigrationUrlEnabled: description: "CloudAccountMigration: Enable Custom SIM Migrator Url.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean companyNames: description: "Name of the company in different locales\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SettingsCompanyNames' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string contactEmails: description: "Contact emails used to notify tenants. Can be one or more user or group alias emails.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array csrAccess: description: "This value indicates whether Customer Service Representatives can login and have readOnly or readWrite access. A value of 'none' means CSR cannot login to the services.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" enum: - readOnly - readWrite - none type: string customBranding: description: "Indicates if the branding is default or custom\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean customCssLocation: description: "Storage URL location where the sanitized custom css is located\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string customHtmlLocation: description: "Storage URL location where the sanitized custom html is located\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string customTranslation: description: "Custom translations (JSON String)\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string defaultCompanyNames: description: "Default name of the Company in different locales\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SettingsDefaultCompanyNames' type: array defaultImages: description: "References to various images\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [type]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SettingsDefaultImages' type: array defaultLoginTexts: description: "Default Login text in different locales\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SettingsDefaultLoginTexts' type: array defaultTrustScope: description: '**Deprecated Since: 18.3.6** **SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: string Indicates the default trust scope for all apps ' enum: - Explicit - Account - Tags type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean diagnosticLevel: description: "The level of diagnostic logging that is currently in effect. A level of 0 (zero) indicates that diagnostic logging is disabled. A level of 1 (one) indicates that diagnostic logging is enabled.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer diagnosticRecordForSearchIdentifiesReturnedResources: description: "Controls whether DiagnosticRecords for external search-operations (against SCIM resource-types in the Admin service) identify returned resources. If true, indicates that for each successful external search-operation at least one DiagnosticRecord will include at least one identifier for each matching resource that is returned in that search-response. If false, no DiagnosticRecord should be expected to identify returned resources for a search-operation. The default value is false.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean diagnosticTracingUpto: description: "The end time up to which diagnostic recording is switched on\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string enableTermsOfUse: description: "Indicates if Terms of Use is enabled in UI\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string iamUpstSessionExpiry: description: "Maximum duration for IAM User Principal Session Token expiry\n\n**Added In:** 2307071836\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array images: description: "References to various images\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [type]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SettingsImages' type: array isHostedPage: description: "Indicates if 'hosted' option was selected\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean issuer: description: "Tenant issuer.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string locale: description: "Default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(locale)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string loginTexts: description: "Login text in different locales\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SettingsLoginTexts' type: array maxNoOfAppCMVAToReturn: description: "Limit the maximum return of CMVA for an App\n\n**Added In:** 2111112015\n\n**SCIM++ Properties:**\n - idcsMinValue: 0\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxNoOfAppRoleMembersToReturn: description: "Limit the maximum return of members for an AppRole\n\n**Added In:** 2111112015\n\n**SCIM++ Properties:**\n - idcsMinValue: 0\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer meta: $ref: '#/components/schemas/meta' migrationStatus: description: "Database Migration Status\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string onPremisesProvisioning: description: "On-Premises provisioning feature toggle.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean preferredLanguage: description: "Preferred written or spoken language used for localized user interfaces\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"languages\" and attrValues.value eq \"$(preferredLanguage)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string prevIssuer: description: "Previous Tenant issuer. This is an Oracle Identity Cloud Service internal attribute which is not meant to be directly modified by ID Admin. Even if the request body (Settings) contains this attribute, the actual value will be set according to the Oracle Identity Cloud Service internal logic rather than solely based on the value provided in the request payload.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string privacyPolicyUrl: description: "Privacy Policy URL\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string purgeConfigs: description: "Purge Configs for different Resource Types\n\n**Deprecated Since: 19.1.6**\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [resourceName]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SettingsPurgeConfigs' type: array reAuthFactor: description: "If reAuthWhenChangingMyAuthenticationFactors is true (default), this attribute specifies which re-authentication factor to use. Allowed value is \\\"password\\\".\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" items: enum: - password type: string type: array reAuthWhenChangingMyAuthenticationFactors: description: "Specifies whether re-authentication is required or not when a user changes one of their security factors such as password or email. Default is true to ensure more secure behavior.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array serviceAdminCannotListOtherUsers: description: "By default, a service admin can list all users in stripe. If true, a service admin cannot list other users.\n\n**Added In:** 2108190438\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean signingCertPublicAccess: description: "Indicates if access on SigningCert is allowed to public or not\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean subMappingAttr: description: '**Added In:** 20.1.3 **SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none Subject mapping user profile attribute. The input format should be SCIM compliant. This attribute should be of type String and multivalued to false. ' type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string tenantCustomClaims: description: "Custom claims associated with the specific tenant\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SettingsTenantCustomClaims' type: array termsOfUseUrl: description: "Terms of Use URL\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string timezone: description: "User's timezone\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"timezones\" and attrValues.value eq \"$(timezone)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string required: - schemas - csrAccess type: object MyDevicePushNotificationTarget: description: "Push Notification target. Reference to Device notification related resource\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the push notification target resource of this device\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" type: string value: description: "The identifier of the push notification target\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 40 minLength: 1 type: string required: - value type: object KmsiSettingsSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array required: - schemas type: object Error: description: "The SCIM Protocol uses the HTTP status response status codes defined\n in [Section 6 [RFC7231](https://tools.ietf.org/html/rfc7231#section-6) to indicate operation success or failure.\n In addition to returning a HTTP response code implementers MUST return\n the errors in the body of the response in the client requested format\n containing the error response and, per the HTTP specification, human-\n readable explanations." properties: detail: description: A detailed, human readable message. OPTIONAL type: string schemas: description: 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 SCIM specified Error and Extn Error Schema. 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. REQUIRED. items: type: string type: array status: description: The HTTP status code (see [Section 6 [RFC7231]](https://tools.ietf.org/html/rfc7231#section-6)) expressed as a JSON String type: string urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error: $ref: '#/components/schemas/ExtensionMessagesError' required: - schemas - status type: object UserSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object definedTags: description: "OCI Defined Tags\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [namespace, key, value]\n - type: complex\n - idcsSearchable: true\n - required: false\n - mutability: readWrite\n - multiValued: true\n - returned: default" properties: key: description: "OCI Tag key\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - required: true\n - mutability: readWrite\n - returned: default\n - idcsSearchable: true\n - uniqueness: none" maxLength: 100 type: string namespace: description: "OCI Tag namespace\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - required: true\n - mutability: readWrite\n - returned: default\n - idcsSearchable: true\n - uniqueness: none" maxLength: 100 type: string value: description: "OCI Tag value\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - required: true\n - idcsReturnEmptyWhenNull: true\n - mutability: readWrite\n - returned: default\n - type: string\n - idcsSearchable: true\n - uniqueness: none" maxLength: 256 type: string required: - namespace - key - value type: object AppConnectorBundle: description: "ConnectorBundle\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "ConnectorBundle URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "ConnectorBundle display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "Connector Bundle type. Allowed values are ConnectorBundle, LocalConnectorBundle.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsDefaultValue: ConnectorBundle\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - ConnectorBundle - LocalConnectorBundle maxLength: 100 minLength: 1 type: string value: description: "ConnectorBundle identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string wellKnownId: description: "Unique Well-known identifier used to reference connector bundle.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value - type type: object SelfRegistrationProfileDefaultGroups: description: Default groups assigned to the user properties: $ref: description: "URI of the Default Group\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Identifier of the Default Group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object SmtpCredentials: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/SmtpCredential' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object UserX509Certificates: description: A list of certificates issued to the User. properties: display: description: "A human readable name, primarily used for display purposes.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label indicating the attribute's function.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The value of a X509 certificate.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: binary\n - uniqueness: none" type: object required: - value type: object Apps: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/App' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object BrandingSettingsDefaultCompanyNames: description: Default name of the Company in different locales properties: locale: description: "Locale\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(companyNames.locale)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Company name\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" maxLength: 50 type: string required: - value - locale type: object UserExtManager: description: "The User's manager. A complex type that optionally allows Service Providers to represent organizational hierarchy by referencing the 'id' attribute of another User.\n\n**SCIM++ Properties:**\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Manager, deprecatedColumnHeaderName:Manager Name, mapsTo:manager.value]]\n - idcsPii: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the SCIM resource representing the User's manager. RECOMMENDED.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string displayName: description: "The displayName of the User's manager. OPTIONAL and READ-ONLY.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The id of the SCIM resource representing the User's manager. RECOMMENDED.\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Manager Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string type: object UserPasswordResetterUserToken: description: "The user token returned if userFlowControlledByExternalClient is set to true.\n\n**SCIM++ Properties:**\n - type: complex\n - multiValued: false\n - required: false\n - caseExact: false\n - mutability: readOnly\n - returned: default\n - uniqueness: none" properties: $ref: description: "The user token URI.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "The user token identifier.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object MyCompletedApproval: description: Schema for MyPendingApproval and MyCompletedApproval properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expires: description: "Time by when ApprovalWorkflowInstance expires\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array justification: description: "Justification for approval\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" maxLength: 4000 type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string requestCreatedTime: description: "The time that the Request was created\n\n**SCIM++ Properties:**\n - multiValued: false\n - idcsSearchable: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string requestDetails: description: "Request Details\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsScimCompliant: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string requestId: description: "The Unique Identifier of the request.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string requestOcid: description: "The OCI Unique Identifier of the request.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string resourceDisplayName: description: "Requested Resource display name\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string resourceType: description: "Requested Resource type\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string responseTime: description: "The time that the user responded to the Approval\n\n**SCIM++ Properties:**\n - multiValued: false\n - idcsSearchable: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "Status of the approver's response on the approval\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 100 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas type: object ApprovalWorkflowAssignmentApprovalWorkflow: description: "Details of the Approval Workflow\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "URI of the approval workflow\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: reference\n - uniqueness: none" type: string display: description: "Display name of the approval workflow\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string ocid: description: "Unique OCI Identifier of the approval workflow\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 type: string type: description: "Indicates type of the entity that is associated with this assignment (for ARM validation)\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - idcsDefaultValue: ApprovalWorkflow\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: request\n - type: string\n - uniqueness: none" enum: - ApprovalWorkflow maxLength: 20 type: string value: description: "Identifier of the approval workflow\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value - type type: object ApprovalWorkflow: description: Schema for ApprovalWorkflow properties: approvalWorkflowSteps: description: "ApprovalWorkflowSteps applicable for the ApprovalWorkflowInstance.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - idcsCompositeKey: [value, type]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/ApprovalWorkflowApprovalWorkflowSteps' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description of the ApprovalWorkflow.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 400 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array maxDuration: $ref: '#/components/schemas/ApprovalWorkflowMaxDuration' meta: $ref: '#/components/schemas/meta' name: description: "Name of the ApprovalWorkflow.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: server" maxLength: 255 minLength: 1 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - name - maxDuration type: object MyDeviceNonCompliances: description: Device Non Compliances properties: action: description: "Device Compliance Action\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" enum: - NOTIFY - BLOCK - ALLOW - UNKNOWN maxLength: 40 minLength: 1 type: string name: description: "Device Compliance name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 100 minLength: 1 type: string value: description: "Device Compliance value\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 100 minLength: 1 type: string required: - name - value - action type: object MappedAttributes: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MappedAttribute' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object NetworkPerimeters: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/NetworkPerimeter' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object SelfRegistrationProfile: description: Self Registration Profile properties: activationEmailRequired: description: '**SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none A Boolean value that indicates whether Account verification email is required to be sent before login or not ' type: boolean active: description: "A Boolean value that indicates whether the profile is enabled or not\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean afterSubmitText: description: "Text to be displayed on UI after doing self registration\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - idcsMultiLanguage: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SelfRegistrationProfileAfterSubmitText' type: array allowedEmailDomains: description: "A Multivalue String value for Email domains which are valid for this profile\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 255 minLength: 1 type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string consentText: description: "Consent text\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - idcsMultiLanguage: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SelfRegistrationProfileConsentText' type: array consentTextPresent: description: "A boolean value that indicates whether the consent text is present.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean defaultGroups: description: "Default groups assigned to the user\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex" items: $ref: '#/components/schemas/SelfRegistrationProfileDefaultGroups' type: array deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean disallowedEmailDomains: description: "A Multivalue String Value for Email domains to be handled as exceptions\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 255 minLength: 1 type: array displayName: description: "Registration page name\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - idcsMultiLanguage: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SelfRegistrationProfileDisplayName' type: array domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string emailTemplate: $ref: '#/components/schemas/SelfRegistrationProfileEmailTemplate' externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string footerLogo: description: "References to footer logo\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: reference" minLength: 1 type: string footerText: description: "Footer text\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - idcsMultiLanguage: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SelfRegistrationProfileFooterText' type: array headerLogo: description: "Reference to header logo\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: reference" minLength: 1 type: string headerText: description: "Header text\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [locale]\n - idcsMultiLanguage: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SelfRegistrationProfileHeaderText' type: array id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' name: description: "Name of the profile\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 255 minLength: 1 type: string numberOfDaysRedirectUrlIsValid: description: "Number of days redirect URL is valid\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string redirectUrl: description: "This URL will be replaced in email notification sent to user. When activation email required is set to true, user is created in \\\"pending verification\\\" state, upon clicking this link user will be able to activate himself. When activation email required is set to false, user is created in \\\"verified\\\" state, this link will be used to verify user's email.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" minLength: 1 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array showOnLoginPage: description: "A Boolean value that indicates whether the profile should be displayed on login page\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string userAttributes: description: '**SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none User Attributes ' items: $ref: '#/components/schemas/SelfRegistrationProfileUserAttributes' type: array required: - schemas - name - activationEmailRequired - numberOfDaysRedirectUrlIsValid - showOnLoginPage - redirectUrl - consentTextPresent - displayName - emailTemplate type: object OAuth2ClientCredential: description: The user's OAuth2 client credentials. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**Added In:** 2101262133\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "When the user's credentials expire.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isResetSecret: description: "Specifies whether the secret must be reset.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean meta: $ref: '#/components/schemas/meta' name: description: "Name\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: true\n - returned: default" maxLength: 4000 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array scopes: description: "Scopes\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [audience, scope]\n - type: complex\n - mutability: readWrite\n - multiValued: true\n - required: true\n - returned: default" items: $ref: '#/components/schemas/OAuth2ClientCredentialScopes' type: array status: description: "The user's credential status.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' user: $ref: '#/components/schemas/OAuth2ClientCredentialUser' required: - schemas - name - scopes type: object OAuthPartnerCertificateSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object SchemaIdcsComplexAttributeNameMappings: description: Specifies the mapping between external identity source attributes and Oracle Identity Cloud Service complex attributes (e.g. email => emails[work].value) properties: idcsRtsaHideAttribute: description: "Specifies if the attributes that is mapped should be hidden externally\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean mapsTo: description: "The attribute that is mapped to the attribute mapping\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The attribute that represents the display name\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - name - mapsTo type: object GroupExtOwners: description: "Group owners\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value, type]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the owning Resource of this Group\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Owner display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "Indicates the type of resource--for example, User or Group\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsDefaultValue: User\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - App type: string value: description: "ID of the owner of this Group\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value - type type: object AppIdpPolicy: description: "IDP Policy.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "URI of the policy.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Identifier of the Policy.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AppExtensionWebTierPolicyApp: description: WebTier Policy properties: resourceRef: description: "If this Attribute is true, resource ref id and resource ref name attributes will we included in wtp json response.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean webTierPolicyAZControl: description: "Webtier policy AZ Control\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - server - local maxLength: 40 minLength: 1 type: string webTierPolicyJson: description: "Store the web tier policy for an application as a string in Javascript Object Notification (JSON) format.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 100000 minLength: 1 type: string type: object IdentityProvider: description: Federation trusted partner Identity Provider properties: assertionAttribute: description: "Assertion attribute name.\n\n**Deprecated Since: 20.1.3**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsValuePersistedInOtherAttribute: true" maxLength: 256 type: string authnRequestBinding: description: "HTTP binding to use for authentication requests.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Redirect - Post type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string correlationPolicy: $ref: '#/components/schemas/IdentityProviderCorrelationPolicy' deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string enabled: description: "Set to true to indicate Partner enabled.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean encryptionCertificate: description: "Encryption certificate\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string iconUrl: description: "Identity Provider Icon URL.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array idpSsoUrl: description: "Identity Provider SSO URL\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string includeSigningCertInSignature: description: "Set to true to include the signing certificate in the signature.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean jitUserProvAssignedGroups: description: "Refers to every group of which a JIT-provisioned User should be a member. Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/IdentityProviderJitUserProvAssignedGroups' type: array jitUserProvAttributeUpdateEnabled: description: "Set to true to indicate JIT User Creation is enabled\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean jitUserProvAttributes: $ref: '#/components/schemas/IdentityProviderJitUserProvAttributes' jitUserProvCreateUserEnabled: description: "Set to true to indicate JIT User Creation is enabled\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean jitUserProvEnabled: description: "Set to true to indicate JIT User Provisioning is enabled\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean jitUserProvGroupAssertionAttributeEnabled: description: "Set to true to indicate JIT User Provisioning Groups should be assigned based on assertion attribute\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean jitUserProvGroupAssignmentMethod: description: "The default value is 'Overwrite', which tells Just-In-Time user-provisioning to replace any current group-assignments for a User with those assigned by assertions and/or those assigned statically. Specify 'Merge' if you want Just-In-Time user-provisioning to combine its group-assignments with those the user already has.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Overwrite - Merge maxLength: 10 type: string jitUserProvGroupMappingMode: description: "Property to indicate the mode of group mapping\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - implicit - explicit maxLength: 40 type: string jitUserProvGroupMappings: description: "The list of mappings between the Identity Domain Group and the IDP group.\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [idpGroup]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/IdentityProviderJitUserProvGroupMappings' type: array jitUserProvGroupSAMLAttributeName: description: "Name of the assertion attribute containing the users groups\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string jitUserProvGroupStaticListEnabled: description: "Set to true to indicate JIT User Provisioning Groups should be assigned from a static list\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean jitUserProvIgnoreErrorOnAbsentGroups: description: "Set to true to indicate ignoring absence of group while provisioning\n\n**Added In:** 2111112015\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsAddedSinceVersion: 30\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean lastNotificationSentTime: description: "Records the notification timestamp for the IdP whose signing certificate is about to expire\n\n**Added In:** 2302092332\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string logoutBinding: description: "HTTP binding to use for logout.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Redirect - Post type: string logoutEnabled: description: "Set to true to enable logout.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean logoutRequestUrl: description: "Logout request URL\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string logoutResponseUrl: description: "Logout response URL\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string meta: $ref: '#/components/schemas/meta' metadata: description: "Metadata\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100000 type: string nameIdFormat: description: "Default authentication request name ID format.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string partnerName: description: "Unique name of the trusted Identity Provider.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: server" maxLength: 100 type: string partnerProviderId: description: "Provider ID\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: server" maxLength: 256 type: string requestedAuthenticationContext: description: "SAML SP authentication type.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 1000 type: array requireForceAuthn: description: "This SP requires requests SAML IdP to enforce re-authentication.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean requiresEncryptedAssertion: description: "SAML SP must accept encrypted assertion only.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean samlHoKRequired: description: "SAML SP HoK Enabled.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array serviceInstanceIdentifier: description: "The serviceInstanceIdentifier of the App that hosts this IdP. This value will match the opcServiceInstanceGUID of any service-instance that the IdP represents.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: server" type: string shownOnLoginPage: description: "Set to true to indicate whether to show IdP in login page or not.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean signatureHashAlgorithm: description: "Signature hash algorithm.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - SHA-1 - SHA-256 type: string signingCertificate: description: "Signing certificate\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string succinctId: description: "Succinct ID\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: server" maxLength: 100 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string tenantProviderId: description: "The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this IdP.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string type: description: "Identity Provider Type\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" enum: - SAML - SOCIAL - IWA - X509 - LOCAL maxLength: 20 minLength: 1 type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:social:IdentityProvider: $ref: '#/components/schemas/ExtensionSocialIdentityProvider' urn:ietf:params:scim:schemas:oracle:idcs:extension:x509:IdentityProvider: $ref: '#/components/schemas/ExtensionX509IdentityProvider' userMappingMethod: description: "User mapping method.\n\n**Deprecated Since: 20.1.3**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsValuePersistedInOtherAttribute: true" enum: - NameIDToUserAttribute - AssertionAttributeToUserAttribute - CorrelationPolicyRule type: string userMappingStoreAttribute: description: "This property specifies the userstore attribute value that must match the incoming assertion attribute value or the incoming nameid attribute value in order to identify the user during SSO.
You can construct the userMappingStoreAttribute value by specifying attributes from the Oracle Identity Cloud Service Core Users schema. For examples of how to construct the userMappingStoreAttribute value, see the Example of a Request Body section of the Examples tab for the POST and PUT methods of the /IdentityProviders endpoint.\n\n**Deprecated Since: 20.1.3**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsValuePersistedInOtherAttribute: true" maxLength: 256 type: string required: - schemas - partnerName - enabled type: object OciConsoleSignOnPolicyConsents: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsent' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppRoles: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/AppRole' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object SelfRegistrationProfileHeaderText: description: Header text properties: default: description: "If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean locale: description: "Type of user's locale e.g. en-CA\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(type)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Localized value of header text in corresponding locale\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string required: - locale - value type: object AppServiceParams: description: Custom attribute that is required to compute other attribute values during app creation. properties: name: description: "The name of the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The value of the attribute.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - name type: object ExtensionSocialAccountUser: description: Social User extension properties: socialAccounts: description: "Description:\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - idcsPii: true\n - type: complex\n - uniqueness: none\n" items: $ref: '#/components/schemas/UserExtSocialAccounts' type: array type: object MyApps: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyApp' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object UserExtRecoveryLocked: description: "A complex attribute that indicates a password recovery is locked (blocking any new sessions).\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: lockDate: description: "The date and time that the current resource was locked.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string 'on': description: "Indicates that the recovery is locked.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: object UserExtAuthTokens: description: "A list of Auth tokens corresponding to user.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding AuthToken resource to which the user belongs.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string ocid: description: "The user's Auth token OCID.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "The user's Auth token identifier.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object MyGroupSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MyUserDbCredentials: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyUserDbCredential' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AuthenticationFactorSettingsEmailSettings: description: "Settings related to Email Factor, such as enabled email magic link factor, custom url for Email Link\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: emailLinkCustomUrl: description: "Custom redirect Url which will be used in email link\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string emailLinkEnabled: description: "Specifies whether Email link is enabled or not.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - emailLinkEnabled type: object ExtensionUserCredentialsUser: description: User's credentials properties: apiKeys: description: "A list of API keys corresponding to user.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtApiKeys' type: array authTokens: description: "A list of Auth tokens corresponding to user.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtAuthTokens' type: array customerSecretKeys: description: "A list of customer secret keys corresponding to user.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtCustomerSecretKeys' type: array dbCredentials: description: "A list of database credentials corresponding to user.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtDbCredentials' type: array oAuth2ClientCredentials: description: "A list of OAuth2 client credentials corresponding to a user.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtOAuth2ClientCredentials' type: array smtpCredentials: description: "A list of SMTP credentials corresponding to user.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtSmtpCredentials' type: array type: object AppUserRoles: description: A list of AppRoles defined by this UnmanagedApp. Membership in each of these AppRoles confers end-user privilege within this App. properties: $ref: description: "URI of the AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string description: description: "The description of the AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string display: description: "Display-name of the AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "ID of the AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object ExtensionAdaptiveUser: description: This extension defines attributes to manage user's risk score. properties: riskLevel: description: "Risk Level\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" enum: - LOW - MEDIUM - HIGH type: string riskScores: description: "The risk score pertaining to the user.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtRiskScores' type: array type: object OciConsoleSignOnPolicyConsentPolicyResource: description: "Policy Resource\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: ocid: description: "Policy Resource Ocid\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" maxLength: 255 minLength: 1 type: string value: description: "Policy Resource Id\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" maxLength: 40 minLength: 1 type: string required: - value - ocid type: object MyRequestableGroupSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object IdentityProviderJitUserProvAssignedGroups: description: Refers to every group of which a JIT-provisioned User should be a member. Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true. properties: $ref: description: "Group URI\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Group identifier\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AppExtensionRadiusAppApp: description: This extension defines attributes specific to Apps that represent instances of Radius App. properties: captureClientIp: description: "If true, capture the client IP address from the RADIUS request packet. IP Address is used for auditing, policy-evaluation and country-code calculation.\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean clientIP: description: "This is the IP address of the RADIUS Client like Oracle Database server. It can be only IP address and not hostname.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" maxLength: 256 type: string countryCodeResponseAttributeId: description: "Vendor-specific identifier of the attribute in the RADIUS response that will contain the end-user's country code. This is an integer-value in the range 1 to 255\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 256 type: string endUserIPAttribute: description: "The name of the attribute that contains the Internet Protocol address of the end-user.\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 256 type: string groupMembershipRadiusAttribute: description: "RADIUS attribute that RADIUS-enabled system uses to pass the group membership\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 4000 type: string groupMembershipToReturn: description: "In a successful authentication response, Oracle Identity Cloud Service will pass user's group information restricted to groups persisted in this attribute, in the specified RADIUS attribute.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppGroupMembershipToReturn' type: array groupNameFormat: description: "Configure the groupNameFormat based on vendor in order to pass it to RADIUS infra\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 256 type: string includeGroupInResponse: description: "Indicates to include groups in RADIUS response\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean" type: boolean passwordAndOtpTogether: description: "Indicates if password and OTP are passed in the same sign-in request or not.\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean port: description: "This is the port of RADIUS Proxy which RADIUS client will connect to.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" maxLength: 256 type: string radiusVendorSpecificId: description: "ID used to identify a particular vendor.\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 256 type: string responseFormat: description: "Configure the responseFormat based on vendor in order to pass it to RADIUS infra\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 256 type: string responseFormatDelimiter: description: "The delimiter used if group membership responseFormat is a delimited list instead of repeating attributes\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 256 type: string secretKey: description: "Secret key used to secure communication between RADIUS Proxy and RADIUS client\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" maxLength: 4000 type: string secretKeyTemporary: description: "Secret key used to secure communication between RADIUS Proxy and RADIUS client. This will be available only for few releases for an internal migration requirement. Use secretKey attribute instead of this attribute for all other requirements.\n\n**Added In:** 2306131901\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsSensitive: encrypt\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string" maxLength: 4000 type: string typeOfRadiusApp: description: "Value consists of type of RADIUS App. Type can be Oracle Database, VPN etc\n\n**Added In:** 2205120021\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 40 type: string required: - clientIP - port - secretKey - includeGroupInResponse type: object MySmtpCredentials: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MySmtpCredential' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MeEmails: description: A complex attribute representing emails properties: pendingVerificationData: description: "Pending e-mail address verification\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string primary: description: "A Boolean value that indicates whether the email address is the primary email address. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean secondary: description: "A Boolean value that indicates whether the email address is the secondary email address. The secondary attribute value 'true' MUST appear no more than once.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "Type of email address\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - work - home - other - recovery type: string value: description: "Email address\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 5 type: string verified: description: "A Boolean value that indicates whether or not the e-mail address is verified\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - value - type type: object SchemaLocalizedDisplayName: description: "Attribute's localized display name\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: locale: description: "Locale used\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Localized display value\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object idcsCreatedBy: description: "The User or App who created the Resource\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: complex" properties: $ref: description: "The URI of the SCIM resource that represents the User or App who created this Resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The displayName of the User or App who created this Resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the SCIM resource that represents the User or App who created this Resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "The type of resource, User or App, that created this Resource\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - App type: string value: description: "The ID of the SCIM resource that represents the User or App who created this Resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value type: object OciConsoleSignOnPolicyConsentSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MyAuthenticationFactorInitiator: description: This schema defines the attributes of Initiator call. properties: additionalAttributes: description: "Additional attributes which will be sent as part of a push notification\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MyAuthenticationFactorInitiatorAdditionalAttributes' type: array authFactor: description: "Auth Factor represents the type of multi-factor authentication channel for which the request has been initiated.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - EMAIL - TOTP - PUSH - SMS - VOICE - PHONE_CALL - THIRDPARTY - FIDO_AUTHENTICATOR - YUBICO_OTP type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean deviceId: description: "Enrolled Device id on which the multi factor has been initiated.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isAccRecEnabled: description: "Flag indicates whether the device is enrolled in account recovery\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string preferenceType: description: "Indicates whether to user passwordless factor to be updated or mfa factor to be updated\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" enum: - PASSWORDLESS - MFA type: string requestId: description: "Unique RequestId generated for each initiator request.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string scenario: description: "Specifies the scenario to initiate.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" enum: - ENROLLMENT - AUTHENTICATION type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyFactor: $ref: '#/components/schemas/MyAuthenticationFactorInitiatorThirdPartyFactor' type: description: "Authentication flow type either SAML / OIDC\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - SAML - OIDC type: string userName: description: "Name of the user who initiates the request.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsPii: true" type: string required: - schemas - authFactor - deviceId type: object GrantGrantor: description: "User conferring the grant to the beneficiary\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete: true\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "Grantor URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Grantor display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string type: description: "Resource type of the grantor. Allowed values are User and App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsDefaultValue: User\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - App - Group - AppEntitlementCollection - DynamicResourceGroup type: string value: description: "Grantor user identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - type type: object OAuthClientCertificateSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object SettingsCompanyNames: description: Name of the company in different locales properties: locale: description: "Locale\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(companyNames.locale)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" type: string value: description: "Company name\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" maxLength: 50 type: string required: - value - locale type: object ApiKeySearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object UserPasswordChanger: description: The schema used to handle a user password change by an administrator. properties: bypassNotification: description: "Indicates whether to send an email notification after a password is changed.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' notificationEmailTemplateId: description: "Specifies the EmailTemplate to be used when sending a notification to the user. If specified, it overrides the default EmailTemplate.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string password: description: "The password attribute. The maximum length for the password is set in the password policy.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: true\n - mutability: writeOnly\n - returned: never\n - uniqueness: none\n - idcsSensitive: none" maxLength: 500 minLength: 1 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' required: - schemas - password type: object SettingsDefaultImages: description: References to various images properties: display: description: "A human-readable name, primarily used for display purposes\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string" type: string type: description: "Indicates the image type\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Image URI\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: reference" type: string required: - value - type type: object IdentitySetting: description: Identity Settings properties: POSIXGid: $ref: '#/components/schemas/IdentitySettingsPOSIXGid' POSIXUid: $ref: '#/components/schemas/IdentitySettingsPOSIXUid' compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string emitLockedMessageWhenUserIsLocked: description: "Indicates whether to show the 'user-is-locked' message during authentication if the user is already locked. The default value is false, which tells the system to show a generic 'authentication-failure' message. This is the most secure behavior. If the option is set to true, the system shows a more detailed 'error-message' that says the user is locked. This is more helpful but is less secure, for example, because the difference in error-messages could be used to determine which usernames exist and which do not.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' myProfile: $ref: '#/components/schemas/IdentitySettingsMyProfile' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string primaryEmailRequired: description: "Indicates whether the primary email is required.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean removeInvalidEmails: description: "Indicates whether to remove non-RFC5322 compliant emails before creating a user.\n\n**Added In:** 2106170416\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean returnInactiveOverLockedMessage: description: '**Added In:** 2302092332 **SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none Determines the PasswordAuthenticator API response when a user is both ''locked'' and ''inactive.'' If false (default), a ''locked'' message is shown. If true, an ''inactive'' message is shown. ' type: boolean schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string tokens: description: "A list of tokens and their expiry length.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [type]\n - multiValued: true\n - required: false\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/IdentitySettingsTokens' type: array userAllowedToSetRecoveryEmail: description: "Indicates whether a user is allowed to change their own recovery email.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - schemas type: object AccountMgmtInfos: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/AccountMgmtInfo' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyAppApp: description: "Application on which the account is based\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Application URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string active: description: "If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App, and only administrative operations can be performed.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean appIcon: description: "Application icon.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 75000 minLength: 1 type: string appThumbnail: description: "Application thumbnail.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 45000 minLength: 1 type: string description: description: "Application description\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string display: description: "Application display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string isAliasApp: description: "If true, this App is an AliasApp and it cannot be granted to an end user directly\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean isLoginTarget: description: "If true, this App allows runtime services to log end users into this App automatically.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isOPCService: description: "If true, this application is an Oracle Public Cloud service-instance.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean loginMechanism: description: "The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use Security Assertion Markup Language protocol.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string serviceTypeURN: description: "This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string showInMyApps: description: "If true, this App will be displayed in the MyApps page of each end-user who has access to this App.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean value: description: "Application identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AppExtensionEnterpriseAppApp: description: This extension defines the Enterprise App related attributes. properties: allowAuthzDecisionTTL: description: "Allow Authz policy decision expiry time in seconds.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsMaxValue: 3600\n - idcsMinValue: 0\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer allowAuthzPolicy: $ref: '#/components/schemas/AppAllowAuthzPolicy' appResources: description: "A list of AppResources of this App.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/AppAppResources' type: array denyAuthzDecisionTTL: description: "Deny Authz policy decision expiry time in seconds.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsMaxValue: 3600\n - idcsMinValue: 0\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer denyAuthzPolicy: $ref: '#/components/schemas/AppDenyAuthzPolicy' type: object OAuth2ClientCredentialSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object AppCertificates: description: Each value of this attribute represent a certificate that this App uses when it acts as an OAuthClient. properties: certAlias: description: "Certificate alias\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string kid: description: "Certificate kid\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string sha1Thumbprint: description: "sha1Thumbprint\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string x509Base64Certificate: description: "Base-64-encoded certificate.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: binary\n - uniqueness: none" type: object x5t: description: "Certificate x5t\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - certAlias type: object MyOAuth2ClientCredentialUser: description: "The user linked to the OAuth2 client credential.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The username.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object UserDbCredentialsSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object addresses: description: A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes. properties: country: description: "The country name component.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"countries\" and attrValues.value eq \"upper($(country))\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string formatted: description: "The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string locality: description: "The city or locality component.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 128 minLength: 1 type: string postalCode: description: "The zipcode or postal code component.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean region: description: "The state or region component.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 128 minLength: 1 type: string streetAddress: description: "The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1024 minLength: 1 type: string type: description: "A label indicating the attribute's function; e.g., 'work' or 'home'.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - work - home - other type: string required: - type type: object MyCompletedApprovals: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyCompletedApproval' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyAuthToken: description: The user's Auth token resource. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 400 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "When the user's credential expire.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "The user's credential status.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string user: $ref: '#/components/schemas/MyAuthTokenUser' required: - schemas type: object MyCustomerSecretKeys: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyCustomerSecretKey' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object SecurityQuestionSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MySupportAccounts: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MySupportAccount' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppBundleConfigurationProperties: description: "ConnectorBundle configuration properties\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: confidential: description: "If true, this bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \\\"isConfidential\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean displayName: description: "Display name of the bundle configuration property. This attribute maps to \\\"displayName\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string helpMessage: description: "Help message of the bundle configuration property. This attribute maps to \\\"helpMessage\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string icfType: description: "ICF data type of the bundle configuration property. This attribute maps to \\\"type\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - Long - String - Character - Double - Float - Integer - Boolean - URI - File - GuardedByteArray - GuardedString - ArrayOfLong - ArrayOfString - ArrayOfCharacter - ArrayOfDouble - ArrayOfFloat - ArrayOfInteger - ArrayOfBoolean - ArrayOfURI - ArrayOfFile - ArrayOfGuardedByteArray - ArrayOfGuardedString type: string name: description: "Name of the bundle configuration property. This attribute maps to \\\"name\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string order: description: "Display sequence of the bundle configuration property.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer required: description: "If true, this bundle configuration property is required to connect to the target connected managed app. This attribute maps to \\\"isRequired\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean value: description: "Value of the bundle configuration property. This attribute maps to \\\"value\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - idcsSensitive: encrypt\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array required: - name - icfType - required type: object SmtpCredentialUser: description: "User linked to smtp credential\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "User name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "User's ocid\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "User's id\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object MyAuthenticationFactorValidatorThirdPartyFactor: description: "User's third-party authentication factor details\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: thirdPartyFactorId: description: "Reference to the third party resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyFactorType: description: "Type of the third party authentication factor\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyVendorName: description: "The vendor name of the third party factor\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - thirdPartyVendorName type: object OAuthPartnerCertificates: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/OAuthPartnerCertificate' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyApiKeys: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyApiKey' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyAppSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object SecurityQuestionQuestionText: description: Locale values for the Question properties: default: description: "If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean locale: description: "The locale\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(locale)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string value: description: "The question text\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value - locale type: object ExtensionGroupGroup: description: Oracle Identity Cloud Service Group properties: appRoles: description: "A list of appRoles that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/GroupExtAppRoles' type: array creationMechanism: description: "Source from which this group got created.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeNameMappings: [[defaultValue:import]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" enum: - bulk - api - adsync - authsync - idcsui - import type: string description: description: "Group description\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Description\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Description]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string grants: description: "Grants assigned to group\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/GroupExtGrants' type: array owners: description: "Group owners\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value, type]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/GroupExtOwners' type: array passwordPolicy: $ref: '#/components/schemas/GroupExtPasswordPolicy' syncedFromApp: $ref: '#/components/schemas/GroupExtSyncedFromApp' type: object NetworkPerimeterSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object AppRole: description: AppRole resource. properties: adminRole: description: "If true, the role provides administrative access privileges.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean app: $ref: '#/components/schemas/AppRoleApp' availableToClients: description: "If true, this AppRole can be granted to Apps.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean availableToGroups: description: "If true, this AppRole can be granted to Groups.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean availableToUsers: description: "If true, this AppRole can be granted to Users.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "AppRole description\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 minLength: 1 type: string displayName: description: "AppRole name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Display Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Entitlement Value]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array legacyGroupName: description: "The name of the legacy group associated with this AppRole.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: server" maxLength: 200 minLength: 1 type: string limitedToOneOrMoreGroups: description: "If true, indicates that this Oracle Identity Cloud Service AppRole can be granted to a delegated administrator whose scope is limited to users that are members of one or more groups.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean localizedDisplayName: description: "AppRole localization name\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string members: description: "AppRole members - when requesting members attribute, it is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10]\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value, type]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Grantee Name, mapsTo:members.value], [columnHeaderName:Grantee Type, mapsTo:members.type]]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - idcsPaginateResponse: true\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppRoleMembers' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string public: description: "If true, this AppRole is available automatically to every Oracle Identity Cloud Service User in this tenancy. There is no need to grant it to individual Users or Groups.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string uniqueName: description: "AppRole unique name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: server" type: string required: - schemas - displayName - app type: object AuthenticationFactorSettingsCompliancePolicy: description: Compliance Policy that defines actions to be taken when a condition is violated properties: action: description: "The action to be taken if the value of the attribute is not as expected\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - Allow - Block - Notify - None type: string name: description: "The name of the attribute being evaluated\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The value of the attribute to be evaluated\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - name - action - value type: object NetworkPerimeter: description: NetworkPerimeter resource. A unit that captures a NetworkPerimeter as a collection of IP Addresses. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "NetworkPerimeter Description\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array ipAddresses: description: "IPAddresses or Ranges assigned to the NetworkPerimeter\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/NetworkPerimeterIpAddresses' type: array meta: $ref: '#/components/schemas/meta' name: description: "NetworkPerimeter name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: server" maxLength: 256 minLength: 1 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - name - ipAddresses type: object AppGroupMembershipToReturn: description: "In a successful authentication response, Oracle Identity Cloud Service will pass user's group information restricted to groups persisted in this attribute, in the specified RADIUS attribute.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding Group resource to which the user belongs\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The identifier of the User's group.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object AppSamlServiceProvider: description: "An attribute that refers to the SAML Service Provider that runtime services will use to log an end user in to this App automatically. Note that this will be used only if the loginMechanism is 'SAML'.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the App that acts as a Service Provider.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "The id of the App that acts as a Service Provider.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object SelfRegistrationProfileUserAttributes: description: 'User Attributes ' properties: deletable: description: "If this attribute can be deleted\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean fullyQualifiedAttributeName: description: '**SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none Fully Qualified Attribute Name ' type: string metadata: description: "Metadata of the user attribute\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string seqNumber: description: '**SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none Sequence Number for the attribute ' type: integer value: description: "name of the attribute\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - seqNumber type: object SettingsCertificateValidation: description: "Certificate Validation Config\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: crlCheckOnOCSPFailureEnabled: description: "Use CRL as Fallback.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean crlEnabled: description: "CRL is enabled Configuration\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean crlLocation: description: "CRL Location.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string crlRefreshInterval: description: "The CRL refresh interval in minutes\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer ocspEnabled: description: "OCSP is enabled Configuration\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean ocspResponderURL: description: "OCSP Responder URL\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocspSettingsResponderURLPreferred: description: "This setting says, OCSP Responder URL present in the issued certificate must be used. Otherwise, OCSP Responder URL from IDP or Settings.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean ocspSigningCertificateAlias: description: "OCSP Signing Certificate Alias\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocspTimeoutDuration: description: "The OCSP Timeout duration in minutes\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - idcsMaxValue: 10\n - idcsMinValue: 1\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer ocspUnknownResponseStatusAllowed: description: "OCSP Accept unknown response status from ocsp responder.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: object PasswordPolicies: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/PasswordPolicy' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyOAuth2ClientCredential: description: The user's OAuth2 client credentials. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**Added In:** 2101262133\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "When the user's credentials expire.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isResetSecret: description: "Specifies whether the secret must be reset.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean meta: $ref: '#/components/schemas/meta' name: description: "Name\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: true\n - returned: default" maxLength: 4000 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array scopes: description: "Scopes\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [audience, scope]\n - type: complex\n - mutability: readWrite\n - multiValued: true\n - required: true\n - returned: default" items: $ref: '#/components/schemas/MyOAuth2ClientCredentialScopes' type: array status: description: "The user's credential status.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string user: $ref: '#/components/schemas/MyOAuth2ClientCredentialUser' required: - schemas - name - scopes type: object GroupExtSyncedFromApp: description: "The entity that created this Group.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "App URI\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "App Display Name\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "The type of the entity that created this Group.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsDefaultValue: App\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - App maxLength: 40 type: string value: description: "The ID of the App.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object BrandingSettings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/BrandingSetting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object UserExtApplicablePasswordPolicy: description: "Applicable Password Policy\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding PasswordPolicy resource.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Password Policy Display Name\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string priority: description: "PasswordPolicy priority\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer value: description: "The identifier of the password policy.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object GroupExtDomainLevelSchemaNames: description: "DBCS Domain-level schema-names. Each value is specific to a DB Domain.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [domainName, schemaName]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex" properties: domainName: description: "DBCS Domain Name\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string schemaName: description: "The DBCS schema-name granted to this group in the DB domain that 'domainName' specifies.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - domainName - schemaName type: object IdentityPropagationTrustKeytab: description: "The keytab stored in the tenancy's Vault. This is required if the identity propagation type is 'SPNEGO'.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [secretOcid]\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: secretOcid: description: "The OCID of the secret. The secret content corresponding to the OCID is expected to be in Base64 encoded content type.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 type: string secretVersion: description: "The version of the secret. When the version is not specified, then the latest secret version is used during runtime.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer required: - secretOcid type: object UserExtSelfRegistrationProfile: description: "Self registration profile used when user is self registered.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "URI of the profile.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string value: description: "Self Registration Profile Id\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AccountMgmtInfoResourceType: description: "Resource Type of the Account\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Resource Type URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Resource Type display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Resource Type Identifier\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value type: object MeX509Certificates: description: A list of certificates issued to the User. properties: display: description: "A human readable name, primarily used for display purposes.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label indicating the attribute's function.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The value of a X509 certificate.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: binary\n - uniqueness: none" type: object required: - value type: object RuleReturn: description: The return values are the then portion of a Rule properties: name: description: "Attribute name of an individual value to be returned.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string returnGroovy: description: "The Groovy script that is run to generate output for the rule, if the policy type allows the return value to be a Groovy script.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Attribute value of some attribute to be returned.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - name - value type: object BrandingSettingsLoginTexts: description: Login text in different locales properties: locale: description: "Locale\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Login text\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string required: - value - locale type: object ResourceTypeSchemaAttributes: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/ResourceTypeSchemaAttribute' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppFormFillUrlMatch: description: "A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [formUrl]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: formUrl: description: "An application formUrl that FormFill will match against any formUrl that a User enters in trying to access the target-service which this App represents.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string formUrlMatchType: description: "Indicates how to interpret the value of 'formUrl' when matching against a user-specified formUrl. The system currently supports only 'Exact', which indicates that the value of 'formUrl' should be treated as a literal value.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - formUrl type: object MyTrustedUserAgentTrustedFactors: description: Trusted 2FA Factors properties: category: description: "Trusted Factor Type. Local, X509, SAML SOCIAL\n\n**Added In:** 2111190457\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - SAML - LOCAL - SOCIAL - X509 - THIRDPARTY maxLength: 40 minLength: 1 type: string creationTime: description: "trust factor creation time\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: true\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string type: description: "Trusted Factor\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsRequiresWriteForAccessFlows: true\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - type - creationTime type: object UserName: description: "A complex attribute that contains attributes representing the name\n\n**SCIM++ Properties:**\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Formatted Name, mapsTo:name.formatted], [columnHeaderName:Honorific Prefix, mapsTo:name.honorificPrefix], [columnHeaderName:First Name, mapsTo:name.givenName], [columnHeaderName:Middle Name, mapsTo:name.middleName], [columnHeaderName:Last Name, mapsTo:name.familyName], [columnHeaderName:Honorific Suffix, mapsTo:name.honorificSuffix]]\n - idcsPii: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: familyName: description: "Last name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Last Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 150 minLength: 1 type: string formatted: description: "Full name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 354 minLength: 1 type: string givenName: description: "First name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: First Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 150 minLength: 1 type: string honorificPrefix: description: "Prefix\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Honorific Prefix\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 25 minLength: 1 type: string honorificSuffix: description: "Suffix\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Honorific Suffix\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 25 minLength: 1 type: string middleName: description: "Middle name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Middle Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string type: object AppExtensionDbcsApp: description: This extension provides attributes for database service facet of an App properties: domainApp: $ref: '#/components/schemas/AppDomainApp' domainName: description: "The name of the Enterprise Domain that contains any number of DBInstances. If specified, the value must be unique. A non-null value indicates that App represents a DBDomain. A value of null indicates that the App represents an DB-instance.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: server" type: string type: object MyDeviceAuthenticationFactors: description: Authentication Factors properties: publicKey: description: "Authentication Factor public key issued by client\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" maxLength: 4000 minLength: 1 type: string status: description: "Authentication Factor Status\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" enum: - INITIATED - INPROGRESS - ENROLLED - LOCKED - INACTIVE - BLOCKED maxLength: 40 minLength: 1 type: string type: description: "Authentication Factor Type\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true" enum: - EMAIL - SMS - TOTP - PUSH - OFFLINETOTP - VOICE - PHONE_CALL - THIRDPARTY - FIDO_AUTHENTICATOR - YUBICO_OTP maxLength: 40 minLength: 1 type: string required: - type type: object ApprovalWorkflowAssignments: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/ApprovalWorkflowAssignment' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppDenyAuthzPolicy: description: "Deny Authz Policy.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "URI of the policy.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Identifier of the Policy.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object UserStatusChanger: description: Schema to handle user status change by administrator. properties: active: description: "User status\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' required: - schemas type: object IdentitySettingsPOSIXUid: description: "A list of Posix Uid settings.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - required: false\n - type: complex\n - uniqueness: none" properties: manualAssignmentEndsAt: description: "The number at which the Posix Uid Manual assignment ends.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer manualAssignmentStartsFrom: description: "The number from which the Posix Uid Manual assignment starts.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer type: object AppExtensionFormFillAppTemplateAppTemplate: description: This extension provides attributes for Form-Fill facet of AppTemplate properties: configuration: description: "FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 10 type: string formCredMethod: description: "Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - ADMIN_SETS_CREDENTIALS - ADMIN_SETS_SHARED_CREDENTIALS - USER_SETS_PASSWORD_ONLY - USER_SETS_CREDENTIALS - SSO_CREDENTIALS_AS_APP_CREDENTIALS maxLength: 200 minLength: 5 type: string formCredentialSharingGroupID: description: "Credential Sharing Group to which this form-fill application belongs.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 5 type: string formFillUrlMatch: description: "A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [formUrl]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppFormFillUrlMatch' type: array formType: description: "Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - WebApplication maxLength: 200 minLength: 5 type: string revealPasswordOnForm: description: "If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean syncFromTemplate: description: "If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate disabled inheritance for these Form-Fill-related attributes.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean userNameFormExpression: description: "Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 5 type: string userNameFormTemplate: description: "Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 5 type: string type: object UserCapabilitiesChanger: description: User Capabilities Changer properties: canUseApiKeys: description: "Indicates whether a user can use API keys.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseAuthTokens: description: "Indicates whether a user can use Auth tokens.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseConsole: description: "Indicates whether a user can use the Console.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsDefaultValue: false\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseConsolePassword: description: "Indicates whether a user can use Console passwords.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseCustomerSecretKeys: description: "Indicates whether a user can use customer secret keys.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseDbCredentials: description: "Indicates whether a user can use database credentials.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseOAuth2ClientCredentials: description: "Indicates whether a user can use OAuth2 client credentials.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseSmtpCredentials: description: "Indicates whether a user can use SMTP credentials.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' required: - schemas type: object SettingsLoginTexts: description: Login text in different locales properties: locale: description: "Locale\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(loginTexts.locale)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" type: string value: description: "Login text\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - idcsSanitize: true\n - type: string" maxLength: 250 type: string required: - value - locale type: object AuthenticationFactorSettingsBypassCodeSettings: description: "Settings related to the bypass code, such as bypass code length, bypass code expiry, max active bypass codes, and so on\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: helpDeskCodeExpiryInMins: description: "Expiry (in minutes) of any bypass code that is generated by the help desk\n\n**SCIM++ Properties:**\n - idcsMaxValue: 9999999\n - idcsMinValue: 1\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer helpDeskGenerationEnabled: description: "If true, indicates that help desk bypass code generation is enabled\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean helpDeskMaxUsage: description: "The maximum number of times that any bypass code that is generated by the help desk can be used\n\n**SCIM++ Properties:**\n - idcsMaxValue: 999\n - idcsMinValue: 1\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer length: description: "Exact length of the bypass code to be generated\n\n**SCIM++ Properties:**\n - idcsMaxValue: 20\n - idcsMinValue: 8\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxActive: description: "The maximum number of bypass codes that can be issued to any user\n\n**SCIM++ Properties:**\n - idcsMaxValue: 6\n - idcsMinValue: 1\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer selfServiceGenerationEnabled: description: "If true, indicates that self-service bypass code generation is enabled\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - selfServiceGenerationEnabled - helpDeskGenerationEnabled - length - maxActive - helpDeskCodeExpiryInMins - helpDeskMaxUsage type: object AccountMgmtInfoUserWalletArtifact: description: "The UserWalletArtifact that contains the credentials that the system will use when performing Secure Form-Fill to log the user in to this application\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "UserWalletArtifact URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "UserWalletArtifact identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object MyAuthenticationFactorInitiatorAdditionalAttributes: description: Additional attributes which will be sent as part of a push notification properties: name: description: "A name of the attribute\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Value of the attribute\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - name type: object CustomerSecretKeys: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/CustomerSecretKey' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AccountRecoverySettings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/AccountRecoverySetting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object CloudGateServers: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/CloudGateServer' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object ApiKeyUser: description: "The user linked to the API key.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The username.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object AppFlatFileBundleConfigurationProperties: description: "Flat file connector bundle configuration properties\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: confidential: description: "If true, this flatfile bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \\\"isConfidential\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean displayName: description: "Display name of the flatfile bundle configuration property. This attribute maps to \\\"displayName\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string helpMessage: description: "Help message of the flatfile bundle configuration property. This attribute maps to \\\"helpMessage\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string icfType: description: "ICF data type of flatfile the bundle configuration property. This attribute maps to \\\"type\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - Long - String - Character - Double - Float - Integer - Boolean - URI - File - GuardedByteArray - GuardedString - ArrayOfLong - ArrayOfString - ArrayOfCharacter - ArrayOfDouble - ArrayOfFloat - ArrayOfInteger - ArrayOfBoolean - ArrayOfURI - ArrayOfFile - ArrayOfGuardedByteArray - ArrayOfGuardedString type: string name: description: "Name of the flatfile bundle configuration property. This attribute maps to \\\"name\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string order: description: "Display sequence of the bundle configuration property.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer required: description: "If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \\\"isRequired\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean value: description: "Value of the flatfile bundle configuration property. This attribute maps to \\\"value\\\" attribute in \\\"ConfigurationProperty\\\" in ICF.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - idcsSensitive: encrypt\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array required: - name - icfType - required type: object IdentitySettingsPOSIXGid: description: "A list of Posix Gid settings.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - required: false\n - type: complex\n - uniqueness: none" properties: manualAssignmentEndsAt: description: "The number at which the Posix Gid Manual assignment ends.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer manualAssignmentStartsFrom: description: "The number from which the Posix Gid Manual assignment starts.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer type: object BrandingSettingsDefaultImages: description: References to various images properties: display: description: "A human-readable name, primarily used for display purposes\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string" type: string type: description: "Indicates the image type\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Image URI\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: reference" type: string required: - value - type type: object OciConsoleSignOnPolicyConsent: description: The "Security Policy for OCI Console" sign-on policy consent resource used to record consents. The schema to record the "Security Policy for OCI Console" sign-on policy consent. properties: changeType: description: "Change Type - MODIFIED or RESTORED_TO_FACTORY_DEFAULT\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - MODIFIED - RESTORED_TO_FACTORY_DEFAULT maxLength: 100 type: string clientIp: description: "Client IP of the Consent Signer\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string consentSignedBy: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsentConsentSignedBy' deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array justification: description: "The justification for the change when an identity domain administrator opts to modify the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string meta: $ref: '#/components/schemas/meta' modifiedResource: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsentModifiedResource' notificationRecipients: description: "The recipients of the email notification for the change in consent.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" items: type: string maxLength: 100 type: array ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string policyResource: $ref: '#/components/schemas/OciConsoleSignOnPolicyConsentPolicyResource' reason: description: "The detailed reason for the change when an identity domain administrator opts to modify the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 minLength: 5 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Tag Key, mapsTo:tags.key], [columnHeaderName:Tag Value, mapsTo:tags.value]]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string timeConsentSigned: description: "Time when Consent was signed.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string required: - schemas - consentSignedBy - modifiedResource - policyResource - changeType - clientIp - justification - timeConsentSigned - notificationRecipients type: object DynamicResourceGroups: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/DynamicResourceGroup' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object UserDbCredential: description: User's Database Credential properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string dbPassword: description: "The user's database password.\n\n**SCIM++ Properties:**\n - type: string\n - mutability: immutable\n - returned: default\n - required: true" maxLength: 128 minLength: 1 type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**Added In:** 2109020413\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expired: description: "Indicates that the database password has expired.\n\n**SCIM++ Properties:**\n - type: boolean\n - mutability: readOnly\n - returned: default" type: boolean expiresOn: description: "When the user credential expires.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array lastSetDate: description: "A DateTime that specifies the date and time when the current database password was set.\n\n**SCIM++ Properties:**\n - type: dateTime\n - mutability: readOnly\n - returned: default" type: string meta: $ref: '#/components/schemas/meta' mixedDbPassword: description: "The user's database password with mixed salt.\n\n**SCIM++ Properties:**\n - type: string\n - mutability: readOnly\n - returned: default\n - required: false" maxLength: 128 minLength: 12 type: string mixedSalt: description: "The mixed salt of the password.\n\n**SCIM++ Properties:**\n - type: string\n - mutability: readOnly\n - returned: default\n - required: false" maxLength: 128 minLength: 12 type: string name: description: "Name\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readOnly\n - required: false\n - returned: default" maxLength: 100 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string salt: description: "The salt of the password.\n\n**SCIM++ Properties:**\n - type: string\n - mutability: readOnly\n - returned: default\n - required: false" maxLength: 128 minLength: 12 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "User credential status\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' user: $ref: '#/components/schemas/UserDbCredentialsUser' required: - schemas - dbPassword type: object CloudGateSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object AuthTokenUser: description: "The user linked to the Auth token.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The username.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object DynamicResourceGroup: description: Schema for DynamicResourceGroup resource. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "text that explains the purpose of this Dynamic Resource Group\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Description\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Description]]\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 1000 type: string displayName: description: "User-friendly, mutable identifier\n\n**SCIM++ Properties:**\n - idcsCsvAttributeName: Display Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Name, deprecatedColumnHeaderName:Display Name]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 500 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string dynamicGroupAppRoles: description: "A list of appRoles that are currently granted to this Dynamic Resource Group. The Identity service will assert these AppRoles for any resource that satisfies the matching-rule of this DynamicResourceGroup.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/DynamicResourceGroupDynamicGroupAppRoles' type: array grants: description: "Grants assigned to group\n\n**SCIM++ Properties:**\n - idcsAddedSinceVersion: 3\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/DynamicResourceGroupGrants' type: array id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array matchingRule: description: "Store as a string the matching-rule for this Dynamic Resource Group. This may match any number of Apps in this Domain, as well as matching any number of OCI resources that are not in any Domain but that are in the OCI Compartment that contains this Domain.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 100000 minLength: 1 type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags: $ref: '#/components/schemas/ExtensionOCITags' required: - schemas - matchingRule - displayName type: object OciConsoleSignOnPolicyConsentConsentSignedBy: description: "User or App that signs the consent.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: displayName: description: "Name of the User or App that signed consent.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" maxLength: 250 minLength: 1 type: string ocid: description: "OCID of the User or App that signed consent.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" maxLength: 255 minLength: 1 type: string type: description: "Type of principal that signed consent: User or App.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" enum: - User - App maxLength: 100 type: string value: description: "Id of the User or App that signed consent.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string" maxLength: 40 minLength: 1 type: string required: - value - ocid - displayName - type type: object GroupExtInstanceLevelSchemaNames: description: "DBCS instance-level schema-names. Each schema-name is specific to a DB Instance.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [dbInstanceId, schemaName]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex" properties: dbInstanceId: description: "App Id of DBCS App instance\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string schemaName: description: "The DBCS schema-name granted to this Group for the DB instance that 'dbInstanceId' specifies.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - dbInstanceId - schemaName type: object ExtensionEnterprise20User: description: Enterprise User properties: costCenter: description: "Identifies the name of a cost center.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Cost Center\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Cost Center]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string department: description: "Identifies the name of a department.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Department\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Department]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 64 minLength: 1 type: string division: description: "Identifies the name of a division.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Division\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Division]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string employeeNumber: description: "Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Employee Number\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Employee Number]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 50 minLength: 1 type: string manager: $ref: '#/components/schemas/UserExtManager' organization: description: "Identifies the name of an organization.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Organization\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Organization Name, deprecatedColumnHeaderName:Organization]]\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 64 minLength: 1 type: string type: object MappedAttribute: description: Schema for MappedAttribute resource. properties: attributeMappings: description: "A list of attribute mappings between Oracle Identity Cloud Service Resource Type and Account Object Class\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [idcsAttributeName, managedObjectAttributeName]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MappedAttributeAttributeMappings' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean direction: description: "Direction of the attribute mapping. inbound indicates mapping is from source ManagedObjectClass to Oracle Identity Cloud Service ResourceType. outbound indicates mapping is from Oracle Identity Cloud Service Resource Type to target ManagedObjectClass.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - inbound - outbound type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array idcsResourceType: description: "The Oracle Identity Cloud Service Resource Type for which the mapping is being done\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - Group - Container type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string refResourceID: description: "Soft Reference to store Resource ID that holds the mapping\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string refResourceType: description: "The Reference Resource Type that holds the mapping\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - AccountObjectClass - App - ManagedObjectClass - IdentityProvider type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - idcsResourceType - refResourceType - refResourceID - direction type: object AppAdminRoles: description: A list of AppRoles defined by this UnmanagedApp. Membership in each of these AppRoles confers administrative privilege within this App. properties: $ref: description: "URI of the AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string description: description: "The description of the AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string display: description: "Display-name of the AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "ID of the AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object MyApp: description: Schema for MyApp resource. properties: accountType: description: "Type of the Acccount\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string active: description: "If true, the account is activated.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean app: $ref: '#/components/schemas/MyAppApp' compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string favorite: description: "If true, this account has been marked as a favorite of the User who owns it.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isAccount: description: "If true, indicates that this managed object is an account, which is an identity that represents a user in the context of a specific application.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean lastAccessed: description: "Last accessed timestamp of an application\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string launchUrl: description: "The URL that will be used to launch the application.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string meta: $ref: '#/components/schemas/meta' name: description: "Name of the Account\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string owner: $ref: '#/components/schemas/MyAppOwner' schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string uid: description: "Unique identifier of the Account.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string userWalletArtifact: $ref: '#/components/schemas/MyAppUserWalletArtifact' required: - schemas - app type: object SelfRegistrationProfileConsentText: description: Consent text properties: default: description: "If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean locale: description: "Type of user's locale e.g. en-CA\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(type)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Localized value of consent text in corresponding locale\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 10000 minLength: 1 type: string required: - locale - value type: object UserPasswordResetter: description: The schema used to handle a user password reset by an administrator. properties: bypassNotification: description: "Indicates whether to send an email notification after resetting the user's password.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: never\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' notificationEmailTemplateId: description: "Specifies the EmailTemplate to be used when sending notifications to the user. If specified, it overrides the default EmailTemplate.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string oneTimePassword: description: "A one time password will be returned when the user doesn't have a primary email address.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" format: password type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User: $ref: '#/components/schemas/ExtensionSelfChangeUser' userFlowControlledByExternalClient: description: "A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow.\n\n**SCIM++ Properties:**\n - type: boolean\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: never\n - uniqueness: none" type: boolean userToken: $ref: '#/components/schemas/UserPasswordResetterUserToken' required: - schemas type: object CloudGateServerSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object ExtensionSocialIdentityProvider: description: Social Identity Provider Extension Schema properties: accessTokenUrl: description: "Social IDP Access token URL\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string accountLinkingEnabled: description: "Whether account linking is enabled\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean adminScope: description: "Admin scope to request\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 1000 type: array authzUrl: description: "Social IDP Authorization URL\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string autoRedirectEnabled: description: "Whether social auto redirect is enabled. The IDP policy should be configured with only one Social IDP, and without username/password selected.\n\n**Added In:** 2310202314\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean clientCredentialInPayload: description: "Whether the client credential is contained in payload\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean clockSkewInSeconds: description: "Social IDP allowed clock skew time\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer consumerKey: description: "Social IDP Client Application Client ID\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string consumerSecret: description: "Social IDP Client Application Client Secret\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsSensitive: encrypt\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string discoveryUrl: description: "Discovery URL\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string idAttribute: description: "Id attribute used for account linking\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string jitProvAssignedGroups: description: "Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true.\n\n**Added In:** 2310202314\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/IdentityProviderJitProvAssignedGroups' type: array jitProvGroupStaticListEnabled: description: "Set to true to indicate Social JIT User Provisioning Groups should be assigned from a static list\n\n**Added In:** 2310202314\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean profileUrl: description: "Social IDP User profile URL\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string redirectUrl: description: "redirect URL for social idp\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string registrationEnabled: description: "Whether registration is enabled\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean relayIdpParamMappings: description: "Relay Param variable for Social IDP\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [relayParamKey]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/IdentityProviderRelayIdpParamMappings' type: array scope: description: "Scope to request\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 1000 type: array serviceProviderName: description: "Service Provider Name\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string socialJitProvisioningEnabled: description: "Whether Social JIT Provisioning is enabled\n\n**Added In:** 2307282043\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean status: description: "Status\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - created - deleted maxLength: 100 type: string required: - accountLinkingEnabled - registrationEnabled - consumerKey - consumerSecret - serviceProviderName type: object SecurityQuestion: description: Security Question properties: active: description: "This indicates if the question is selected by the Security Admin and is available for the end user.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string questionText: description: "Locale values for the Question\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: always\n - idcsCompositeKey: [locale]\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SecurityQuestionQuestionText' type: array schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "This indicates if the question is a Custom Question added by the Security Admin.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" enum: - default - custom type: string required: - schemas - active - type - questionText type: object ExtensionRequestableGroup: description: Requestable Group properties: requestable: description: "Flag controlling whether group membership can be request by user through self service console.\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Requestable, mapsTo:requestable]]\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean type: object AppGrantedAppRoles: description: A list of AppRoles that are granted to this App (and that are defined by other Apps). Within the Oracle Public Cloud infrastructure, this allows AppID-based association. Such an association allows this App to act as a consumer and thus to access resources of another App that acts as a producer. properties: $ref: description: "The URI of an AppRole that is granted to this App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string adminRole: description: "If true, then this granted AppRole confers administrative privileges within the App that defines it. Otherwise, the granted AppRole confers only functional privileges.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean appId: description: "The id of the App that defines this AppRole, which is granted to this App. The App that defines the AppRole acts as the producer; the App to which the AppRole is granted acts as a consumer.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string appName: description: "The name of the App that defines this AppRole, which is granted to this App. The App that defines the AppRole acts as the producer; the App to which the AppRole is granted acts as a consumer.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string display: description: "The display-name of an AppRole that is granted to this App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string legacyGroupName: description: "The name of the legacy group associated with this AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string readOnly: description: "If true, indicates that this value must be protected.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label that indicates whether this AppRole was granted directly to the App (or indirectly through a Group). For an App, the value of this attribute will always be 'direct' (because an App cannot be a member of a Group).\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - direct - indirect type: string value: description: "The id of an AppRole that is granted to this App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value type: object AppBundlePoolConfiguration: description: "Configurable options maintaining a pool of ICF connector instances. Values for sub attributes can be set only if the ConnectorBundle referenced in the App has connectorPoolingSupported set to true\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: maxIdle: description: "Maximum number of connector instances in the pool that are idle and active.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxObjects: description: "Maximum number of connector instances in the pool that are idle and active.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxWait: description: "Maximum time (in milliseconds) to wait for a free connector instance to become available before failing.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minEvictableIdleTimeMillis: description: "Minimum time (in milliseconds) to wait before evicting an idle conenctor instance from the pool.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer minIdle: description: "Minimum number of idle connector instances in the pool.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer type: object ApprovalWorkflowStepApprovers: description: Approvers of the ApprovalWorkflowStep. properties: $ref: description: "Approver URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The display of the approver.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The unique OCI identifier of the approver.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string type: description: "The type of the approver.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "The unique identifier of the approver.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object AuthenticationFactorSettingsEndpointRestrictions: description: "Settings that describe the set of restrictions that the system should apply to devices and trusted endpoints of a user\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: maxEndpointTrustDurationInDays: description: "Maximum number of days until an endpoint can be trusted\n\n**SCIM++ Properties:**\n - idcsMaxValue: 180\n - idcsMinValue: 1\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxEnrolledDevices: description: "Maximum number of enrolled devices per user\n\n**SCIM++ Properties:**\n - idcsMaxValue: 20\n - idcsMinValue: 1\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxIncorrectAttempts: description: "An integer that represents the maximum number of failed MFA logins before an account is locked\n\n**SCIM++ Properties:**\n - idcsMaxValue: 20\n - idcsMinValue: 5\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer maxTrustedEndpoints: description: "Max number of trusted endpoints per user\n\n**SCIM++ Properties:**\n - idcsMaxValue: 20\n - idcsMinValue: 1\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer trustedEndpointsEnabled: description: "Specify if trusted endpoints are enabled\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - maxEnrolledDevices - maxTrustedEndpoints - maxEndpointTrustDurationInDays - trustedEndpointsEnabled - maxIncorrectAttempts type: object UserExtSyncedFromApp: description: "Managed App or an Identity Source from where the user is synced. If enabled, this Managed App or Identity Source can be used for performing delegated authentication.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "App URI\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "App Display Name\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "A label that indicates whether this is an App or IdentitySource.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - idcsDefaultValue: IdentitySource\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - IdentitySource - App - IdentityProvider maxLength: 40 type: string value: description: "App identifier\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object SelfRegistrationProfiles: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/SelfRegistrationProfile' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object SmtpCredentialSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object AppAppSignonPolicy: description: "App Sign-on Policy.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "URI of the policy.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Identifier of the Policy.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AuthenticationFactorSettingsTotpSettings: description: "Settings related to Time-Based One-Time Passcodes (TOTP), such as hashing algo, totp time step, passcode length, and so on\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: emailOtpValidityDurationInMins: description: "The period of time (in minutes) that a one-time passcode remains valid that the system sends by email.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - idcsMaxValue: 60\n - idcsMinValue: 2\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer emailPasscodeLength: description: "Exact length of the email one-time passcode.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - idcsMaxValue: 10\n - idcsMinValue: 4\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer hashingAlgorithm: description: "The hashing algorithm to be used to calculate a One-Time Passcode. By default, the system uses SHA1.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - SHA1 - SHA256 - SHA384 - SHA512 - MD5 type: string jwtValidityDurationInSecs: description: "The period of time (in seconds) that a JSON Web Token (JWT) is valid\n\n**SCIM++ Properties:**\n - idcsMaxValue: 99999\n - idcsMinValue: 30\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer keyRefreshIntervalInDays: description: "The duration of time (in days) after which the shared secret has to be refreshed\n\n**SCIM++ Properties:**\n - idcsMaxValue: 999\n - idcsMinValue: 30\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer passcodeLength: description: "Exact length of the One-Time Passcode that the system should generate\n\n**SCIM++ Properties:**\n - idcsMaxValue: 10\n - idcsMinValue: 4\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer smsOtpValidityDurationInMins: description: "The period of time (in minutes) for which a One-Time Passcode that the system sends by Short Message Service (SMS) or by voice remains valid\n\n**SCIM++ Properties:**\n - idcsMaxValue: 60\n - idcsMinValue: 2\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer smsPasscodeLength: description: "Exact length of the Short Message Service (SMS) One-Time Passcode\n\n**SCIM++ Properties:**\n - idcsMaxValue: 10\n - idcsMinValue: 4\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer timeStepInSecs: description: "Time (in secs) to be used as the time step\n\n**SCIM++ Properties:**\n - idcsMaxValue: 300\n - idcsMinValue: 30\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer timeStepTolerance: description: "The tolerance/step-size that the system should use when validating a One-Time Passcode\n\n**SCIM++ Properties:**\n - idcsMaxValue: 3\n - idcsMinValue: 2\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer required: - hashingAlgorithm - passcodeLength - keyRefreshIntervalInDays - timeStepInSecs - timeStepTolerance - smsOtpValidityDurationInMins - jwtValidityDurationInSecs - smsPasscodeLength - emailOtpValidityDurationInMins - emailPasscodeLength type: object ApprovalWorkflowMaxDuration: description: "Max duration of the ApprovalWorkflow must be acted at all levels.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: unit: description: "The unit of the max duration.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsDefaultValue: DAY\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - MONTH - WEEK - DAY - HOUR maxLength: 40 type: string value: description: "The value of the max duration.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsMaxValue: 1488\n - idcsMinValue: 1\n - idcsDefaultValue: 14\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer required: - value - unit type: object AppExtensionSamlServiceProviderApp: description: This extension defines attributes related to the Service Providers configuration. properties: assertionConsumerUrl: description: "The attribute represents the URL to which the SAML Assertions will be sent by the SAML IdP.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string encryptAssertion: description: "If true, indicates that the system must encrypt the Security Assertion Markup Language (SAML) assertion.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean encryptionAlgorithm: description: "This attribute indicates the encryption algorithm used to encrypt the SAML assertion.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - 3DES - AES-128 - AES-256 - AES-192 - AES-128-GCM - AES-256-GCM - AES-192-GCM type: string encryptionCertificate: description: "This attribute represents the encryption certificate that an App uses to encrypt the Security Assertion Markup Language (SAML) assertion.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100000 minLength: 1 type: string federationProtocol: description: "Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1).\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsDefaultValue: SAML2.0\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - SAML2.0 - WS-Fed1.1 maxLength: 40 type: string groupAssertionAttributes: description: "Each value of this attribute describes an attribute of Group that will be sent in a Security Assertion Markup Language (SAML) assertion.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppGroupAssertionAttributes' type: array hokAcsUrl: description: "Hok Assertion Consumer Service Url\n\n**Added In:** 2101262133\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string hokRequired: description: "If enabled, then the SAML Service supports Hok for this App.\n\n**Added In:** 2101262133\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean includeSigningCertInSignature: description: "If true, then the signing certificate is included in the signature.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean keyEncryptionAlgorithm: description: "This attribute indicates the key encryption algorithm.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - RSA-v1.5 - RSA-OAEP maxLength: 40 type: string lastNotificationSentTime: description: "Records the notification timestamp for the SP whose signing certificate is about to expire.\n\n**Added In:** 2302092332\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string logoutBinding: description: "This attribute represents the HTTP binding that would be used while logout.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Redirect - Post type: string logoutEnabled: description: "If true, then the SAML Service supports logout for this App.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean logoutRequestUrl: description: "The URL to which the partner sends the logout request.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string logoutResponseUrl: description: "The URL to which the partner sends the logout response.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string metadata: description: "This attribute represents the metadata of a Security Provider in the Security Assertion Markup Language protocol.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100000 type: string nameIdFormat: description: "This can be any string, but there are a set of standard nameIdFormats. If a nameIdFormat other than the standard list is chosen, it will be considered a custom nameidformat. The standard nameidformats include: saml-x509, saml-emailaddress, saml-windowsnamequalifier, saml-kerberos, saml-persistent, saml-transient, saml-unspecified, saml-none, and saml-persistent-opaque.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string nameIdUserstoreAttribute: description: '**Deprecated Since: 18.2.2** **SCIM++ Properties:** - caseExact: false - idcsSearchable: true - idcsValuePersistedInOtherAttribute: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none This property specifies which user attribute is used as the NameID value in the SAML assertion. This attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema. ' maxLength: 512 type: string outboundAssertionAttributes: $ref: '#/components/schemas/AppOutboundAssertionAttributes' partnerProviderId: description: "The ID of the Provider. This value corresponds to the entityID from the Service Provider metadata.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string partnerProviderPattern: description: "The pattern of the Provider. This value corresponds to the entityID from the Service Provider metadata.\n\n**Added In:** 2202230830\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 256 type: string signResponseOrAssertion: description: "Indicates which part of the response should be signed. A value of \\\"Assertion\\\" indicates that the Assertion should be signed. A value of \\\"Response\\\" indicates that the SSO Response should be signed. A value of \\\"AssertionAndResponse\\\" indicates that both the Assertion and the SSO Response should be signed.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Assertion - Response - AssertionAndResponse type: string signatureHashAlgorithm: description: "This attribute represents the algorithm used to hash the signature.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - SHA-1 - SHA-256 type: string signingCertificate: description: "This attribute represents the signing certificate that an App uses to verify the signed authentication request.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100000 minLength: 1 type: string succinctId: description: "This attribute represents the Succinct ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: server" maxLength: 100 type: string tenantProviderId: description: "The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this SP.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string userAssertionAttributes: description: "Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion.\n\n**Deprecated Since: 18.2.2**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - idcsValuePersistedInOtherAttribute: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppUserAssertionAttributes' type: array type: object UserExtSocialAccounts: description: "Description:\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - idcsPii: true\n - type: complex\n - uniqueness: none\n" properties: $ref: description: "The URI of the corresponding SocialAccount resource linked with the user\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: type: string required: - value type: object CustomerSecretKeySearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MappedAttributeSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MePhotos: description: URLs of photos for the User properties: display: description: "A human readable name, primarily used for display purposes.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 1 type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred photo or thumbnail. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label indicating the attribute's function; e.g., 'photo' or 'thumbnail'.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - photo - thumbnail type: string value: description: "URL of a photo for the User\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: reference\n - uniqueness: none" maxLength: 2000 minLength: 1 type: string required: - value - type type: object UserDbCredentials: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/UserDbCredential' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AuthenticationFactorsRemover: description: This schema defines the attributes of Authentication Factors Remover call. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string token: description: "Specifies the token to be removed\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: request\n - uniqueness: none\n - idcsSearchable: false" type: string type: description: "Specifies the type of factors to remove. Either MFA factors or AccountRecovery factors or All factors\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" enum: - KMSI - MFA - ACCOUNTRECOVERY - ALL type: string user: $ref: '#/components/schemas/AuthenticationFactorsRemoverUser' required: - schemas - user type: object AppRadiusPolicy: description: "RADIUS Policy assigned to this application.\n\n**Added In:** 2209070044\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "URI of the policy.\n\n**Added In:** 2209070044\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Identifier of the Policy.\n\n**Added In:** 2209070044\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object OAuth2ClientCredentials: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/OAuth2ClientCredential' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppAppsNetworkPerimeters: description: Network Perimeter properties: $ref: description: "URI of the Network Perimeter.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "List of identifier of Network Perimeters for App\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object SettingsPurgeConfigs: description: Purge Configs for different Resource Types properties: resourceName: description: "Resource Name\n\n**Deprecated Since: 19.1.6**\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" type: string retentionPeriod: description: "Retention Period\n\n**Deprecated Since: 19.1.6**\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer" enum: - 30 - 60 - 90 type: integer required: - resourceName - retentionPeriod type: object UserAttributesSettingsAttributeSettings: description: User Schema Attribute Settings properties: endUserMutability: description: "End User mutability\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"mutabilityValues\" and attrValues.value eq \"$(endUserMutability)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string endUserMutabilityCanonicalValues: description: "Specifies the list of User mutabilities allowed.\n\n**Added In:** 18.3.4\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"mutabilityValues\" and attrValues.value eq \"$(endUserMutability)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array name: description: "Fully-qualified attribute or complex mapping Name\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - name - endUserMutability type: object MyAuthenticationFactorInitiatorThirdPartyFactor: description: "User's third-party authentication factor details\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: thirdPartyFactorId: description: "Reference to the third party resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyFactorType: description: "Type of the third party authentication factor\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyVendorName: description: "The vendor name of the third party factor\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - thirdPartyVendorName type: object AuthenticationFactorSettingsDuoSecuritySettings: description: "Settings related to Duo Security\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: apiHostname: description: "Hostname to access the Duo security account\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string attestationKey: description: "Attestation key to attest the request and response between Duo Security\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" type: string integrationKey: description: "Integration key from Duo Security authenticator\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string secretKey: description: "Secret key from Duo Security authenticator\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string userMappingAttribute: description: "User attribute mapping value\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - primaryEmail - userName - givenName type: string required: - integrationKey - secretKey - apiHostname - userMappingAttribute type: object MyGroups: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyGroup' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object PolicyRules: description: Rules assigned to this policy properties: $ref: description: "Rule URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string name: description: "Rule name\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string sequence: description: "Position of the rule in evaluation order. No duplicates allowed.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer value: description: "Rule identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value - sequence type: object MyCustomerSecretKey: description: The user's customer secret key. properties: accessKey: description: "The access key.\n\n**SCIM++ Properties:**\n - caseExact: true\n - type: string\n - mutability: readOnly\n - required: false\n - returned: default" type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string displayName: description: "Display Name\n\n**SCIM++ Properties:**\n - caseExact: false\n - type: string\n - mutability: readWrite\n - required: false\n - returned: default" maxLength: 4000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expiresOn: description: "When the user's credential expire.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "The user's credential status.\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" enum: - ACTIVE - INACTIVE maxLength: 10 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string user: $ref: '#/components/schemas/MyCustomerSecretKeyUser' required: - schemas type: object AppExtensionFormFillAppApp: description: This extension provides attributes for Form-Fill facet of App properties: configuration: description: "FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 10 type: string formCredMethod: description: "Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - ADMIN_SETS_CREDENTIALS - ADMIN_SETS_SHARED_CREDENTIALS - USER_SETS_PASSWORD_ONLY - USER_SETS_CREDENTIALS maxLength: 200 minLength: 5 type: string formCredentialSharingGroupID: description: "Credential Sharing Group to which this form-fill application belongs.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 5 type: string formFillUrlMatch: description: "A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [formUrl]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppFormFillUrlMatch' type: array formType: description: "Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - WebApplication maxLength: 200 minLength: 5 type: string revealPasswordOnForm: description: "If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean syncFromTemplate: description: "If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate on which this App is based has disabled inheritance for these Form-Fill-related attributes.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean userNameFormExpression: description: "Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 5 type: string userNameFormTemplate: description: "Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 200 minLength: 5 type: string type: object UserRoles: description: A list of roles for the User that collectively represent who the User is; e.g., 'Student', 'Faculty'. properties: display: description: "A human readable name, primarily used for display purposes.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string primary: description: "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: description: "A label indicating the attribute's function.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The value of a role.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string required: - value - type type: object AppAliasApps: description: Each value of this internal attribute refers to an Oracle Public Cloud infrastructure App on which this App depends. properties: $ref: description: "URI of the alias App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string description: description: "Description of the alias App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string display: description: "Display name of the alias App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "ID of the alias App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value type: object PasswordPolicySearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object ApprovalWorkflowStep: description: Schema for ApprovalWorkflowStep properties: approvers: description: "Approvers of the ApprovalWorkflowStep.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - idcsCompositeKey: [value, type]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/ApprovalWorkflowStepApprovers' type: array approversExpressions: description: "approversExpressions of ApprovalWorkflowStep\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 100 minLength: 1 type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' minimumApprovals: description: "Minimum number of Approvals required for this step.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsMinValue: 1\n - idcsMaxValue: 2147483647\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string order: description: "Order of the ApprovalWorkflowStep.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - idcsMaxValue: 2147483647\n - required: true\n - returned: default\n - type: integer\n - uniqueness: none" type: integer schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "Type of ApprovalWorkflowStep\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - escalation - regular maxLength: 100 minLength: 1 type: string required: - schemas - order - type type: object BrandingSettingsDefaultLoginTexts: description: Default Login text in different locales properties: locale: description: "Locale\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(loginTexts.locale)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" type: string value: description: "Login text\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string" maxLength: 250 type: string required: - value - locale type: object AppIdentityBridges: description: "IdentityBridges associated with this App\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the IdentityBridge associated with the App.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string name: description: "Name of the IdentityBridge associated with the App.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "The Id of the IdentityBridge associated with the App.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string type: object CloudGateExtUpstreamServers: description: A list of upstream servers properties: $ref: description: "URI of the upstream server\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string displayName: description: "Display name of upstream server\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string groupId: description: "Upstream Server Group instance for the upstream server. This is one of the upstreamServerGroup IDs(upstream blocks) from the associated Cloud Gate list\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string hostName: description: "Any incoming request to cloud gate is finally sent to this host, if selected during load balancing\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string nginxSettings: description: "Any additional settings for this upstream server in nginx configuration form\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string port: description: "Port for the Upstream Server\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer value: description: "ID of the upstream server\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object IdentityProviderSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object MyGroup: description: The Group resource. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean displayName: description: "The Group display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Display Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Name, deprecatedColumnHeaderName:Display Name]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 3000 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array members: description: "The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use 'startIndex' and 'count' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:User Members, mapsTo:members[User].value, multiValueDelimiter:;]]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - idcsPaginateResponse: true\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MyGroupMembers' type: array meta: $ref: '#/components/schemas/meta' nonUniqueDisplayName: description: "A human readable name for the group as defined by the Service Consumer.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Non-Unique Display Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string" maxLength: 3000 minLength: 1 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group: $ref: '#/components/schemas/ExtensionGroupGroup' urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group: $ref: '#/components/schemas/ExtensionPosixGroup' required: - schemas - displayName type: object UserExtBypassCodes: description: "A list of bypass codes that belongs to the user.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding BypassCode resource which belongs to user\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "The user's bypass code identifier.\n\n**Added In:** 18.3.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value type: object SelfRegistrationProfileDisplayName: description: Registration page name properties: default: description: "If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean locale: description: "Type of user's locale e.g. en-CA\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCanonicalValueSourceFilter: attrName eq \"locales\" and attrValues.value eq \"$(type)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Localized value of displayName in corresponding locale\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 minLength: 1 type: string required: - locale - value type: object SettingsTenantCustomClaims: description: Custom claims associated with the specific tenant properties: allScopes: description: "Indicates if the custom claim is associated with all scopes\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean expression: description: "Indicates if the custom claim is an expression\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean mode: description: "Indicates under what scenario the custom claim will be return\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - always - request - never type: string name: description: "Custom claim name\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: server" maxLength: 100 type: string scopes: description: "Scopes associated with a specific custom claim\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tokenType: description: "Indicates what type of token the custom claim will be embedded\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - AT - IT - BOTH type: string value: description: "Custom claim value\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string required: - name - value - mode - expression - allScopes - tokenType type: object IdentitySettingsSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array required: - schemas type: object ApiKeys: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/ApiKey' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object CloudGateServerCloudGate: description: "Reference to owning Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the owning Cloud Gate for this server block.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "The id of the owning Cloud Gate.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object App: description: Schema for App resource. properties: accessTokenExpiry: description: "Expiry-time in seconds for an Access Token. Any token that allows access to this App will expire after the specified duration.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer accounts: description: "Accounts of App\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppAccounts' type: array active: description: "If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App, and only administrative operations can be performed.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean adminRoles: description: "A list of AppRoles defined by this UnmanagedApp. Membership in each of these AppRoles confers administrative privilege within this App.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex" items: $ref: '#/components/schemas/AppAdminRoles' type: array aliasApps: description: "Each value of this internal attribute refers to an Oracle Public Cloud infrastructure App on which this App depends.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppAliasApps' type: array allUrlSchemesAllowed: description: "If true, indicates that the system should allow all URL-schemes within each value of the 'redirectUris' attribute. Also indicates that the system should not attempt to confirm that each value of the 'redirectUris' attribute is a valid URI. In particular, the system should not confirm that the domain component of the URI is a top-level domain and the system should not confirm that the hostname portion is a valid system that is reachable over the network.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean allowAccessControl: description: "If true, any managed App that is based on this template is checked for access control that is, access to this app is subject to successful authorization at SSO service, viz. app grants to start with.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean allowOffline: description: "If true, indicates that the Refresh Token is allowed when this App acts as an OAuth Resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean allowedGrants: description: "List of grant-types that this App is allowed to use when it acts as an OAuthClient.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array allowedOperations: description: "OPTIONAL. Required only when this App acts as an OAuthClient. Supported values are 'introspect' and 'onBehalfOfUser'. The value 'introspect' allows the client to look inside the access-token. The value 'onBehalfOfUser' overrides how the client's privileges are combined with the privileges of the Subject User. Ordinarily, authorization calculates the set of effective privileges as the intersection of the client's privileges and the user's privileges. The value 'onBehalfOf' indicates that authorization should ignore the privileges of the client and use only the user's privileges to calculate the effective privileges.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: enum: - introspect - onBehalfOfUser type: string type: array allowedScopes: description: "A list of scopes (exposed by this App or by other Apps) that this App is allowed to access when it acts as an OAuthClient.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [fqs]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppAllowedScopes' type: array allowedTags: description: "A list of tags, acting as an OAuthClient, this App is allowed to access.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppAllowedTags' type: array appIcon: description: "Application icon.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 75000 minLength: 1 type: string appSignonPolicy: $ref: '#/components/schemas/AppAppSignonPolicy' appThumbnail: description: "Application thumbnail.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 45000 minLength: 1 type: string appsNetworkPerimeters: description: "Network Perimeter\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/AppAppsNetworkPerimeters' type: array asOPCService: $ref: '#/components/schemas/AppAsOPCService' attrRenderingMetadata: description: "Label for the attribute to be shown in the UI.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - multiValued: true\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppAttrRenderingMetadata' type: array audience: description: "The base URI for all of the scopes defined in this App. The value of 'audience' is combined with the 'value' of each scope to form an 'fqs' or fully qualified scope.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string basedOnTemplate: $ref: '#/components/schemas/AppBasedOnTemplate' bypassConsent: description: "If true, indicates that consent should be skipped for all scopes\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean callbackServiceUrl: description: "Callback Service URL\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string certificates: description: "Each value of this attribute represent a certificate that this App uses when it acts as an OAuthClient.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [certAlias]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppCertificates' type: array clientIPChecking: description: "Network Perimeters checking mode\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - anywhere - whitelisted maxLength: 40 type: string clientSecret: description: "This value is the credential of this App, which this App supplies as a password when this App authenticates to the Oracle Public Cloud infrastructure. This value is also the client secret of this App when it acts as an OAuthClient.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - idcsSensitive: none\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string clientType: description: "Specifies the type of access that this App has when it acts as an OAuthClient.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - confidential - public - trusted type: string cloudControlProperties: description: "A collection of arbitrary properties that scope the privileges of a cloud-control App.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppCloudControlProperties' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string contactEmailAddress: description: "Contact Email Address\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string delegatedServiceNames: description: "Service Names allow to use OCI signature for client authentication instead of client credentials\n\n**Added In:** 2207040824\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 40 minLength: 1 type: array deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Description of the application.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 minLength: 1 type: string disableKmsiTokenAuthentication: description: "Indicates whether the application is allowed to be access using kmsi token.\n\n**Added In:** 2111190457\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: boolean\n - uniqueness: none" type: boolean displayName: description: "Display name of the application. Display name is intended to be user-friendly, and an administrator can change the value at any time.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: server" maxLength: 250 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string editableAttributes: description: "App attributes editable by subject\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppEditableAttributes' type: array errorPageUrl: description: "This attribute specifies the URL of the page to which an application will redirect an end-user in case of error.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string grantedAppRoles: description: "A list of AppRoles that are granted to this App (and that are defined by other Apps). Within the Oracle Public Cloud infrastructure, this allows AppID-based association. Such an association allows this App to act as a consumer and thus to access resources of another App that acts as a producer.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppGrantedAppRoles' type: array grants: description: "Grants assigned to the app\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppGrants' type: array hashedClientSecret: description: "Hashed Client Secret. This hash-value is used to verify the 'clientSecret' credential of this App\n\n**Added In:** 2106240046\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsSensitive: hash_sc\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" maxLength: 500 minLength: 1 type: string homePageUrl: description: "Home Page URL\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string icon: description: "URL of application icon.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" maxLength: 200 minLength: 1 type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idTokenEncAlgo: description: "Encryption Alogrithm to use for encrypting ID token.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 minLength: 1 type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array identityProviders: description: "A list of IdentityProvider assigned to app. A user trying to access this app will be automatically redirected to configured IdP during the authentication phase, before being able to access App.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex" items: $ref: '#/components/schemas/AppIdentityProviders' type: array idpPolicy: $ref: '#/components/schemas/AppIdpPolicy' infrastructure: description: "If true, this App is an internal infrastructure App.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isAliasApp: description: "If true, this App is an AliasApp and it cannot be granted to an end-user directly.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: boolean\n - uniqueness: none" type: boolean isDatabaseService: description: "If true, this application acts as database service Application\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - type: boolean" type: boolean isEnterpriseApp: description: "If true, this app acts as Enterprise app with Authentication and URL Authz policy.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isFormFill: description: "If true, this application acts as FormFill Application\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isKerberosRealm: description: "If true, indicates that this App supports Kerberos Authentication\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isLoginTarget: description: "If true, this App allows runtime services to log end users into this App automatically.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isManagedApp: description: "If true, indicates that access to this App requires an account. That is, in order to log in to the App, a User must use an application-specific identity that is maintained in the remote identity-repository of that App.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isMobileTarget: description: "If true, indicates that the App should be visible in each end-user's mobile application.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isMulticloudServiceApp: description: "If true, indicates the app is used for multicloud service integration.\n\n**Added In:** 2301202328\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isOAuthClient: description: "If true, this application acts as an OAuth Client\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isOAuthResource: description: "If true, indicates that this application acts as an OAuth Resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isOPCService: description: "If true, this application is an Oracle Public Cloud service-instance.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isObligationCapable: description: "This flag indicates if the App is capable of validating obligations with the token for allowing access to the App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isRadiusApp: description: "If true, this application acts as an Radius App\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isSamlServiceProvider: description: "If true, then this App acts as a SAML Service Provider.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isUnmanagedApp: description: "If true, indicates that this application accepts an Oracle Cloud Identity Service User as a login-identity (does not require an account) and relies for authorization on the User's memberships in AppRoles.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean isWebTierPolicy: description: "If true, the webtier policy is active\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean landingPageUrl: description: "The URL of the landing page for this App, which is the first page that an end user should see if runtime services log that end user in to this App automatically.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string linkingCallbackUrl: description: "This attribute specifies the callback URL for the social linking operation.\n\n**Added In:** 18.2.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string loginMechanism: description: "The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use Security Assertion Markup Language protocol.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - OIDC - SAML - FORMFILL - RADIUS type: string loginPageUrl: description: "This attribute specifies the URL of the page that the App uses when an end-user signs in to that App.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string logoutPageUrl: description: "This attribute specifies the URL of the page that the App uses when an end-user signs out.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string logoutUri: description: "OAuth will use this URI to logout if this App wants to participate in SSO, and if this App's session gets cleared as part of global logout. Note: This attribute is used only if this App acts as an OAuthClient.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string meta: $ref: '#/components/schemas/meta' meterAsOPCService: description: "Indicates whether the application is billed as an OPCService. If true, customer is not billed for runtime operations of the app.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: boolean\n - uniqueness: none" type: boolean migrated: description: "If true, this App was migrated from an earlier version of Oracle Public Cloud infrastructure (and may therefore require special handling from runtime services such as OAuth or SAML). If false, this App requires no special handling from runtime services.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean name: description: "Name of the application. Also serves as username if the application authenticates to Oracle Public Cloud infrastructure. This name may not be user-friendly and cannot be changed once an App is created.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: server" maxLength: 100 minLength: 2 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string postLogoutRedirectUris: description: "Each value of this attribute is the URI of a landing page within this App. It is used only when this App, acting as an OAuthClient, initiates the logout flow and wants to be redirected back to one of its landing pages.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array privacyPolicyUrl: description: "Privacy Policy URL\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string productLogoUrl: description: "Application Logo URL\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string productName: description: "Product Name\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string protectableSecondaryAudiences: description: "A list of secondary audiences--additional URIs to be added automatically to any OAuth token that allows access to this App. Note: This attribute is used mainly for backward compatibility in certain Oracle Public Cloud Apps.\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppProtectableSecondaryAudiences' type: array radiusPolicy: $ref: '#/components/schemas/AppRadiusPolicy' readyToUpgrade: description: "If true, this App requires an upgrade and mandates attention from application administrator. The flag is used by UI to indicate this app is ready to upgrade.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean redirectUris: description: "OPTIONAL. Each value is a URI within this App. This attribute is required when this App acts as an OAuthClient and is involved in three-legged flows (authorization-code flows).\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array refreshTokenExpiry: description: "Expiry-time in seconds for a Refresh Token. Any token that allows access to this App, once refreshed, will expire after the specified duration.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer samlServiceProvider: $ref: '#/components/schemas/AppSamlServiceProvider' schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array scopes: description: "Scopes defined by this App. Used when this App acts as an OAuth Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppScopes' type: array secondaryAudiences: description: "A list of secondary audiences--additional URIs to be added automatically to any OAuth token that allows access to this App. Note: This attribute is used mainly for backward compatibility in certain Oracle Public Cloud Apps.\n\n**Deprecated Since: 18.2.6**\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array serviceParams: description: "Custom attribute that is required to compute other attribute values during app creation.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: always\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AppServiceParams' type: array serviceTypeURN: description: "This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string serviceTypeVersion: description: "This value specifies the version of the Oracle Public Cloud service of which this App is an instance\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string showInMyApps: description: "If true, this app will be displayed in the MyApps page of each end-user who has access to the App.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean signonPolicy: $ref: '#/components/schemas/AppSignonPolicy' tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string termsOfServiceUrl: description: "Terms of Service URL\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 minLength: 1 type: string termsOfUse: $ref: '#/components/schemas/AppTermsOfUse' trustPolicies: description: "Trust Policies.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/AppTrustPolicies' type: array trustScope: description: "Indicates the scope of trust for this App when acting as an OAuthClient. A value of 'Explicit' indicates that the App is allowed to access only the scopes of OAuthResources that are explicitly specified as 'allowedScopes'. A value of 'Account' indicates that the App is allowed implicitly to access any scope of any OAuthResource within the same Oracle Cloud Account. A value of 'Tags' indicates that the App is allowed to access any scope of any OAuthResource with a matching tag within the same Oracle Cloud Account. A value of 'Default' indicates that the Tenant default trust scope configured in the Tenant Settings is used.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Explicit - Account - Tags - Default type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags: $ref: '#/components/schemas/ExtensionOCITags' urn:ietf:params:scim:schemas:oracle:idcs:extension:dbcs:App: $ref: '#/components/schemas/AppExtensionDbcsApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:enterpriseApp:App: $ref: '#/components/schemas/AppExtensionEnterpriseAppApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:formFillApp:App: $ref: '#/components/schemas/AppExtensionFormFillAppApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:formFillAppTemplate:AppTemplate: $ref: '#/components/schemas/AppExtensionFormFillAppTemplateAppTemplate' urn:ietf:params:scim:schemas:oracle:idcs:extension:kerberosRealm:App: $ref: '#/components/schemas/AppExtensionKerberosRealmApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:managedapp:App: $ref: '#/components/schemas/AppExtensionManagedappApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:multicloudServiceApp:App: $ref: '#/components/schemas/AppExtensionMulticloudServiceAppApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:opcService:App: $ref: '#/components/schemas/AppExtensionOpcServiceApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:radiusApp:App: $ref: '#/components/schemas/AppExtensionRadiusAppApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:requestable:App: $ref: '#/components/schemas/AppExtensionRequestableApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:samlServiceProvider:App: $ref: '#/components/schemas/AppExtensionSamlServiceProviderApp' urn:ietf:params:scim:schemas:oracle:idcs:extension:webTierPolicy:App: $ref: '#/components/schemas/AppExtensionWebTierPolicyApp' userRoles: description: "A list of AppRoles defined by this UnmanagedApp. Membership in each of these AppRoles confers end-user privilege within this App.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex" items: $ref: '#/components/schemas/AppUserRoles' type: array required: - schemas - displayName - basedOnTemplate type: object AppRoleMembers: description: 'AppRole members - when requesting members attribute, it is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10]' properties: $ref: description: "The URI corresponding to the member Resource of this Group\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Member display name\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "Indicates the type of Resource--for example, User, Group or DynamicResourceGroup\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeName: Member Type\n - idcsDefaultValue: User\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - Group - DynamicResourceGroup maxLength: 40 type: string value: description: "ID of the member of this AppRole\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCsvAttributeName: Member\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object CloudGateOauthClient: description: "A reference to the OAuth client App used by this Cloud Gate instance.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the OAuth app for this CloudGate.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string clientId: description: "The Client ID of the OAuth app for this CloudGate.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 minLength: 2 type: string value: description: "The id of the OAuth app for this CloudGate.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object SocialIdentityProvider: description: Social Identity Provider properties: accessTokenUrl: description: "Social IDP Access token URL\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string accountLinkingEnabled: description: "Whether account linking is enabled\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean adminScope: description: "Admin scope to request\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 1000 type: array authzUrl: description: "Social IDP Authorization URL\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string autoRedirectEnabled: description: "Whether social auto redirect is enabled. The IDP policy should be configured with only one Social IDP, and without username/password selected.\n\n**Added In:** 2310202314\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean clientCredentialInPayload: description: "Whether the client credential is contained in payload\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean clockSkewInSeconds: description: "Social IDP allowed clock skew time\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string consumerKey: description: "Social IDP Client Application Client ID\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string consumerSecret: description: "Social IDP Client Application Client Secret\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - idcsSensitive: encrypt\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Social IDP description\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 type: string discoveryUrl: description: "Discovery URL\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string enabled: description: "Whether the IDP is enabled or not\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean iconUrl: description: "ICON URL for social idp\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idAttribute: description: "Id attribute used for account linking\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array jitProvAssignedGroups: description: "Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true.\n\n**Added In:** 2309290043\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SocialIdentityProviderJitProvAssignedGroups' type: array jitProvGroupStaticListEnabled: description: "Set to true to indicate Social JIT User Provisioning Groups should be assigned from a static list\n\n**Added In:** 2309290043\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean meta: $ref: '#/components/schemas/meta' name: description: "Social provider name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 100 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string profileUrl: description: "Social IDP User profile URL\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string redirectUrl: description: "redirect URL for social idp\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string refreshTokenUrl: description: "Social IDP Refresh token URL\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string registrationEnabled: description: "Whether registration is enabled\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean relayIdpParamMappings: description: "Relay Param variable for Social IDP\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [relayParamKey]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/SocialIdentityProviderRelayIdpParamMappings' type: array schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array scope: description: "Scope to request\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 1000 type: array serviceProviderName: description: "Service Provider Name\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string showOnLogin: description: "Whether show on login\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean socialJitProvisioningEnabled: description: "Whether Social JIT Provisioning is enabled\n\n**Added In:** 2307282043\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean status: description: "Status\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - created - deleted maxLength: 100 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas - name - enabled - accountLinkingEnabled - registrationEnabled - showOnLogin - consumerKey - consumerSecret - serviceProviderName type: object ExtensionUserStateUser: description: This extension defines the attributes used to manage account passwords within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords. properties: lastFailedLoginDate: description: "The last failed login date.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsAllowUpdatesInReadOnlyMode: true\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string lastSuccessfulLoginDate: description: "The last successful login date.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - idcsAllowUpdatesInReadOnlyMode: true\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string locked: $ref: '#/components/schemas/UserExtLocked' loginAttempts: description: "The number of failed login attempts. The value is reset to 0 after a successful login.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsAllowUpdatesInReadOnlyMode: true\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - idcsRequiresImmediateReadAfterWriteForAccessFlows: true\n - required: false\n - returned: request\n - type: integer\n - uniqueness: none" type: integer maxConcurrentSessions: description: "The maximum number of concurrent sessions for a user.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsMaxValue: 999\n - idcsMinValue: 1\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer previousSuccessfulLoginDate: description: "The previous successful login date.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string recoveryAttempts: description: "The number of failed recovery attempts. The value is reset to 0 after a successful login.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - idcsRequiresWriteForAccessFlows: true\n - required: false\n - returned: request\n - type: integer\n - uniqueness: none" type: integer recoveryEnrollAttempts: description: "The number of failed account recovery enrollment attempts.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: integer\n - uniqueness: none" type: integer recoveryLocked: $ref: '#/components/schemas/UserExtRecoveryLocked' type: object GroupExtGrants: description: "Grants assigned to group\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "Grant URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string appId: description: "App identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string grantMechanism: description: "Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.\nA customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR':\n - 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User.\n - 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group.\n - 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - IMPORT_APPROLE_MEMBERS - ADMINISTRATOR_TO_USER - ADMINISTRATOR_TO_GROUP - SERVICE_MANAGER_TO_USER - ADMINISTRATOR_TO_APP - SERVICE_MANAGER_TO_APP - OPC_INFRA_TO_APP - GROUP_MEMBERSHIP type: string value: description: "Grant identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object UserAttributesSetting: description: Schema for End User Attribute mutability properties: attributeSettings: description: "User Schema Attribute Settings\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/UserAttributesSettingsAttributeSettings' type: array compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas type: object MyPendingApproval: description: Schema for MyPendingApproval and MyCompletedApproval properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string expires: description: "Time by when ApprovalWorkflowInstance expires\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array justification: description: "Justification for approval\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" maxLength: 4000 type: string meta: $ref: '#/components/schemas/meta' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string requestCreatedTime: description: "The time that the Request was created\n\n**SCIM++ Properties:**\n - multiValued: false\n - idcsSearchable: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string requestDetails: description: "Request Details\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsScimCompliant: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string requestId: description: "The Unique Identifier of the request.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string requestOcid: description: "The OCI Unique Identifier of the request.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string resourceDisplayName: description: "Requested Resource display name\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string resourceType: description: "Requested Resource type\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string responseTime: description: "The time that the user responded to the Approval\n\n**SCIM++ Properties:**\n - multiValued: false\n - idcsSearchable: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array status: description: "Status of the approver's response on the approval\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 100 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - schemas type: object AuthenticationFactorSetting: description: Multi Factor Authentication Settings for Tenant properties: autoEnrollEmailFactorDisabled: description: "If true, indicates that email will not be enrolled as a MFA factor automatically if it a account recovery factor\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean bypassCodeEnabled: description: "If true, indicates that Bypass Code is enabled for authentication\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean bypassCodeSettings: $ref: '#/components/schemas/AuthenticationFactorSettingsBypassCodeSettings' clientAppSettings: $ref: '#/components/schemas/AuthenticationFactorSettingsClientAppSettings' compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string compliancePolicy: description: "Compliance Policy that defines actions to be taken when a condition is violated\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [name]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AuthenticationFactorSettingsCompliancePolicy' type: array deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string emailEnabled: description: "If true, indicates that the EMAIL channel is enabled for authentication\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean emailSettings: $ref: '#/components/schemas/AuthenticationFactorSettingsEmailSettings' endpointRestrictions: $ref: '#/components/schemas/AuthenticationFactorSettingsEndpointRestrictions' fidoAuthenticatorEnabled: description: "If true, indicates that the Fido Authenticator channels are enabled for authentication\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean hideBackupFactorEnabled: description: "If true, indicates that 'Show backup factor(s)' button will be hidden during authentication\n\n**Added In:** 19.3.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array identityStoreSettings: $ref: '#/components/schemas/AuthenticationFactorSettingsIdentityStoreSettings' meta: $ref: '#/components/schemas/meta' mfaEnabledCategory: description: "Specifies the category of people for whom Multi-Factor Authentication is enabled. This is a readOnly attribute which reflects the value of mfaEnabledCategory attribute in SsoSettings\n\n**Deprecated Since: 18.1.2**\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string mfaEnrollmentType: description: "Specifies if Multi-Factor Authentication enrollment is mandatory or optional for a user\n\n**Deprecated Since: 18.1.2**\n\n**SCIM++ Properties:**\n - idcsCanonicalValueSourceFilter: attrName eq \"mfaEnrollmentType\" and attrValues.value eq \"$(mfaEnrollmentType)\"\n - idcsCanonicalValueSourceResourceType: AllowedValue\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string notificationSettings: $ref: '#/components/schemas/AuthenticationFactorSettingsNotificationSettings' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string phoneCallEnabled: description: "If true, indicates that the phone (PHONE_CALL) channel is enabled for authentication\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean pushEnabled: description: "If true, indicates that the Mobile App Push Notification channel is enabled for authentication\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array securityQuestionsEnabled: description: "If true, indicates that Security Questions are enabled for authentication\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean smsEnabled: description: "If true, indicates that the Short Message Service (SMS) channel is enabled for authentication\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyFactor: $ref: '#/components/schemas/AuthenticationFactorSettingsThirdPartyFactor' totpEnabled: description: "If true, indicates that the Mobile App One Time Passcode channel is enabled for authentication\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean totpSettings: $ref: '#/components/schemas/AuthenticationFactorSettingsTotpSettings' urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings: $ref: '#/components/schemas/ExtensionFidoAuthenticationFactorSettings' urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings: $ref: '#/components/schemas/ExtensionThirdPartyAuthenticationFactorSettings' userEnrollmentDisabledFactors: description: "Factors for which enrollment should be blocked for End User\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: enum: - EMAIL - SMS - TOTP - PUSH - OFFLINETOTP - VOICE - PHONE_CALL - THIRDPARTY - FIDO_AUTHENTICATOR - YUBICO_OTP type: string type: array yubicoOtpEnabled: description: "If true, indicates that the Yubico OTP is enabled for authentication\n\n**Added In:** 2109090424\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - schemas - smsEnabled - totpEnabled - pushEnabled - bypassCodeEnabled - securityQuestionsEnabled - mfaEnrollmentType - notificationSettings - bypassCodeSettings - clientAppSettings - endpointRestrictions - compliancePolicy - totpSettings type: object Groups: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/Group' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object IdentityProviders: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/IdentityProvider' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object ExtensionMeUser: description: Oracle Identity Cloud Service self service schema extension properties: currentPassword: description: "The current password is required if the user attempts to change the values of attributes that are used in recovering or verifying the user's own identity. If the current password is specified, it will be used to authenticate the user regardless of any change in these attribute values\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - idcsSensitive: hash\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string\n - uniqueness: none" maxLength: 500 minLength: 1 type: string type: object CustomerSecretKeyUser: description: "User linked to customer secret key\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI that corresponds to the user linked to this credential.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The user's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string name: description: "The user's name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The user's OCID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string value: description: "The user's ID.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string type: object SchemaLocalizedCanonicalValues: description: A collection of Localized canonical values. properties: canonicalValue: description: "Canonical values\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array locale: description: "Locale used\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "Localized display value\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object CloudGateMappingServer: description: "Reference to server block for this mapping\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI to the server block entry\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "The id of the server block entry.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object AuthTokens: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/AuthToken' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object ExtensionSecurityQuestionsUser: description: This extension defines the attributes used to store the security questions of a user. properties: secQuestions: description: "The schema used to mnage security question and answers provided by a user for account recovery and/or MFA. While setting up security questions, a user can also provide a hint for the answer.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtSecQuestions' type: array type: object AppTrustPolicies: description: Trust Policies. properties: $ref: description: "URI of the policy.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Identifier of the Policy.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object ExtensionPasswordlessUser: description: This extension defines attributes used to manage Passwordless-Factor Authentication within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA. properties: factorIdentifier: $ref: '#/components/schemas/UserExtFactorIdentifier' factorMethod: description: "Authentication Factor Method\n\n**Added In:** 2009232244\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string factorType: description: "Authentication Factor Type\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - EMAIL - SMS - PHONE_CALL - TOTP - PUSH - OFFLINETOTP - SECURITY_QUESTIONS - VOICE - USERNAME_PASSWORD - THIRDPARTY - FIDO_AUTHENTICATOR maxLength: 40 minLength: 1 type: string type: object SocialIdentityProviderSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object AccountMgmtInfoOwner: description: "Owning user of the account\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "User URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "User display name\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string email: description: "The email address of this user\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string userName: description: "User name\n\n**SCIM++ Properties:**\n - idcsPii: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string value: description: "User Identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AppAllowAuthzPolicy: description: "Allow Authz Policy.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "URI of the policy.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string value: description: "Identifier of the Policy.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object ExtensionDynamicGroup: description: Dynamic Group properties: membershipRule: description: "Membership rule\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 4000 type: string membershipType: description: "Membership type\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" enum: - static - dynamic maxLength: 40 type: string type: object NotificationSetting: description: Notification resource. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string eventSettings: description: "Event settings\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [eventId]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/NotificationSettingsEventSettings' type: array externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string fromEmailAddress: $ref: '#/components/schemas/NotificationSettingsFromEmailAddress' id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' notificationEnabled: description: "Tenant level settings for the notification service\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array sendNotificationToOldAndNewPrimaryEmailsWhenAdminChangesPrimaryEmail: description: "If true and admin changed user's primary email, send user's profile changed email to old and new primary email address.\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean sendNotificationsToSecondaryEmail: description: "Indicates whether to allow notifications on a secondary email.\n\n**Deprecated Since: 19.2.1**\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string testModeEnabled: description: "Specify if the notification service is in test mode\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean testRecipients: description: "List of the test recipient email addresses\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array required: - schemas - notificationEnabled - fromEmailAddress - eventSettings type: object GroupExtAppRoles: description: "A list of appRoles that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" properties: $ref: description: "The URI of the corresponding appRole resource to which the user belongs\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: reference\n - uniqueness: none" type: string adminRole: description: "If true, then the role provides administrative access privileges. READ-ONLY.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean appId: description: "ID of parent App. READ-ONLY.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string appName: description: "Name of parent App. READ-ONLY.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string legacyGroupName: description: "The name of the legacy group associated with this AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "A label indicating the attribute's function; e.g., 'direct' or 'indirect'.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" enum: - direct - indirect type: string value: description: "The identifier of the appRole\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object UserExtDelegatedAuthenticationTargetApp: description: "If set, indicates the user's preferred authentication target app. If not set and the user's \\\"syncedFromApp\\\" is set and is enabled for delegated authentication, it is used. Otherwise, the user authenticates locally to Oracle Identity Cloud Service.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "App URI\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "App Display Name\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "A label that indicates whether this is an App or IdentitySource.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - idcsDefaultValue: IdentitySource\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - App - IdentitySource maxLength: 40 type: string value: description: "App identifier\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value - type type: object MeGroups: description: A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated properties: $ref: description: "The URI of the corresponding Group resource to which the user belongs\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string dateAdded: description: "Date when the member is Added to the group\n\n**Added In:** 2105200541\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. READ-ONLY.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string membershipOcid: description: "The membership OCID.\n\n**Added In:** 2103141444\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string nonUniqueDisplay: description: "A human readable name for Group as defined by the Service Consumer. READ-ONLY.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the User's group.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "A label indicating the attribute's function; e.g., 'direct' or 'indirect'.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" enum: - direct - indirect type: string value: description: "The identifier of the User's group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" type: string required: - value type: object Policy: description: Policy resource. A named list of rules. properties: active: description: "If true, Policy is active.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Policy Description\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array meta: $ref: '#/components/schemas/meta' name: description: "Policy name\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 256 minLength: 1 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string policyGroovy: description: "The Groovy script that is run instead of the policy, if the policy type allows the policy to be a Groovy script.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string policyType: $ref: '#/components/schemas/PolicyPolicyType' rules: description: "Rules assigned to this policy\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/PolicyRules' type: array schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Tag Key, mapsTo:tags.key], [columnHeaderName:Tag Value, mapsTo:tags.value]]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:ociconsolesignonpolicyconsent:Policy: $ref: '#/components/schemas/PolicyExtensionOciconsolesignonpolicyconsentPolicy' required: - schemas - name - policyType type: object MyPendingApprovals: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyPendingApproval' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyRequestableGroupMembers: description: 'The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use ''startIndex'' and ''count'' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.' properties: $ref: description: "The URI that corresponds to the member Resource of this group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string dateAdded: description: "The date and time that the member was added to the group.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string display: description: "The member's display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string membershipOcid: description: "The membership OCID.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 255 type: string name: description: "The member's name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the member of this group.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 255 type: string type: description: "Indicates the type of resource, for example, User or Group.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - idcsDefaultValue: User\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - User maxLength: 10 type: string value: description: "The ID of the member of this Group\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value - type type: object ExtensionKerberosUserUser: description: Kerberos User extension properties: realmUsers: description: "A list of kerberos realm users for an Oracle Identity Cloud Service User\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/UserExtRealmUsers' type: array type: object RuleConditionGroup: description: "Condition or ConditionGroup assigned to the rule\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "ConditionGroup URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string name: description: "Condition or ConditionGroup name\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "A label that indicates whether this is Condition or ConditionGroup.\n\n**SCIM++ Properties:**\n - idcsDefaultValue: Condition\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - Condition - ConditionGroup maxLength: 40 minLength: 1 type: string value: description: "Condition or ConditionGroup identifier.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - type type: object AppSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array count: description: 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](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4)). OPTIONAL. maxLength: 1000 minLength: 1 type: integer filter: description: The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See [Section 3.4.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.2). OPTIONAL. type: string schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array sortBy: description: 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 ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See [Sorting section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3). OPTIONAL. type: string sortOrder: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. enum: - ASCENDING - DESCENDING type: string x-obmcs-top-level-enum: '#/definitions/SortOrder' startIndex: description: An integer that indicates the 1-based index of the first query result. See [Pagination Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.4). OPTIONAL. type: integer required: - schemas type: object ExtensionDbCredentialsUser: description: The database credentials user extension. properties: dbLoginAttempts: description: "The number of failed login attempts. The value is reset to 0 after a successful login.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: integer\n - uniqueness: none" type: integer dbUserName: description: "The database username.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - type: string\n - returned: request\n - caseExact: false\n - uniqueness: none\n - idcsSearchable: true" maxLength: 128 minLength: 1 type: string type: object DynamicResourceGroupDynamicGroupAppRoles: description: A list of appRoles that are currently granted to this Dynamic Resource Group. The Identity service will assert these AppRoles for any resource that satisfies the matching-rule of this DynamicResourceGroup. properties: $ref: description: "The URI of the corresponding appRole resource to which the user belongs\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: reference\n - uniqueness: none" type: string adminRole: description: "If true, then the role provides administrative access privileges. READ-ONLY.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean appId: description: "ID of parent App. READ-ONLY.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string appName: description: "Name of parent App. READ-ONLY.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string display: description: "A human readable name, primarily used for display purposes. READ-ONLY.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string legacyGroupName: description: "The name of the legacy group associated with this AppRole.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string value: description: "The identifier of the appRole\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 type: string required: - value type: object SettingsSearchRequest: description: Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the **.search** path extension. The inclusion of **.search** on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in **.search**). The body of the POST request MAY include any of the parameters. properties: attributeSets: description: '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. OPTIONAL.' items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' type: array attributes: description: A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation ([Section 3.10](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.10)) form. See ([additional retrieval query parameters](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.9)). OPTIONAL. items: type: string type: array schemas: description: '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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.' items: type: string type: array required: - schemas type: object SchemaResolveValueUsingResourceType: description: This attribute gives a maps for resolving Resource Type after reading it's value from "csvColumnForResolvingResourceType" attribute properties: resolveBy: description: "Specifies the Resource type with which the value given in \\\"valueToBeResolved\\\" attribute should be resolved\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string valueToBeResolved: description: "Specifies the value which should be resolved by a Resource type.\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: object Settings: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/Setting' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object IdentityPropagationTrust: description: Schema used for Identity Propagation Trust. properties: accountId: description: "The Identity cloud provider service identifier, for example, the Azure Tenancy ID, AWS Account ID, or GCP Project ID.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - caseExact: true\n - idcsSearchable: true\n - uniqueness: none" maxLength: 4000 type: string active: description: "If true, specifies that this Identity Propagation Trust is in an enabled state. The default value is false.\n\n**SCIM++ Properties:**\n - type: boolean\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: true" type: boolean allowImpersonation: description: "Allow customers to define whether the resulting token should contain the authenticated user as the subject or whether the token should impersonate another Application Principal in IAM.\n\n**SCIM++ Properties:**\n - type: boolean\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" type: boolean clientClaimName: description: "The claim name that identifies to whom the JWT/SAML token is issued. If AWS, then \\\"aud\\\" or \\\"client_id\\\". If Azure, then \\\"appid\\\". If GCP, then \\\"aud\\\".\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" maxLength: 256 type: string clientClaimValues: description: "The value that corresponds to the client claim name used to identify to whom the token is issued.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: true\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - caseExact: true\n - idcsSearchable: false" items: type: string maxLength: 4000 type: array clockSkewSeconds: description: "The clock skew (in secs) that's allowed for the token issue and expiry time.\n\n**Added In:** 2308181911\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "The description of the Identity Propagation Trust.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - caseExact: false\n - idcsSearchable: false" maxLength: 1000 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array impersonationServiceUsers: description: "The Impersonating Principal.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [rule, value]\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/IdentityPropagationTrustImpersonationServiceUsers' type: array issuer: description: "The issuer claim of the Identity provider.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: true\n - mutability: readWrite\n - returned: always\n - caseExact: true\n - idcsSearchable: true\n - uniqueness: server" maxLength: 4000 minLength: 1 type: string keytab: $ref: '#/components/schemas/IdentityPropagationTrustKeytab' meta: $ref: '#/components/schemas/meta' name: description: "The name of the the Identity Propagation Trust.\n\n**SCIM++ Properties:**\n - type: string\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - required: true\n - mutability: immutable\n - returned: default\n - uniqueness: none" maxLength: 256 minLength: 1 type: string oauthClients: description: "The value of all the authorized OAuth Clients.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 1000 type: array ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string publicCertificate: description: "Store the public key if public key cert.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" maxLength: 4000 type: string publicKeyEndpoint: description: "The cloud provider's public key API of SAML and OIDC providers for signature validation.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - caseExact: false\n - idcsSearchable: false" maxLength: 1000 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array subjectClaimName: description: "Used for locating the subject claim from the incoming token.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - caseExact: true\n - idcsSearchable: false" maxLength: 1000 type: string subjectMappingAttribute: description: "Subject Mapping Attribute to which the value from subject claim name value would be used for identity lookup.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - idcsSearchable: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none" maxLength: 4000 type: string subjectType: description: "The type of the resource against which lookup will be made in the identity domain in IAM for the incoming subject claim value.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - App maxLength: 4000 type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "The type of the inbound token from the Identity cloud provider.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - required: true\n - mutability: readWrite\n - returned: default\n - type: string\n - multiValued: false\n - uniqueness: none" enum: - JWT - SAML - SPNEGO - AWS maxLength: 256 minLength: 1 type: string required: - schemas - name - type - issuer type: object PolicyExtensionOciconsolesignonpolicyconsentPolicy: description: This extension defines attributes used to record consent for modification of the "Security Policy for OCI Console" sign-on policy, Rule, Condition or ConditionGroup. properties: consent: description: "Set to true when an identity domain administrator opts to change the Oracle security defaults for the \"Security Policy for OCI Console\" shipped by Oracle. Defaults to false.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: boolean" type: boolean justification: description: "The justification for the change when an identity domain administrator opts to modify the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string" type: string reason: description: "The detailed reason for the change when an identity domain administrator opts to modify the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string" maxLength: 250 minLength: 5 type: string type: object ExtensionPasswordStateUser: description: This extension defines attributes used to manage account passwords within a Service Provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords. properties: applicablePasswordPolicy: $ref: '#/components/schemas/UserExtApplicablePasswordPolicy' cantChange: description: "Indicates that the current password MAY NOT be changed and all other password expiry settings SHALL be ignored\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean cantExpire: description: "Indicates that the password expiry policy will not be applied for the current Resource\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean expired: description: "Indicates that the password has expired\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean lastFailedValidationDate: description: "A DateTime that specifies the date and time when last failed password validation was set\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string lastSuccessfulSetDate: description: "A DateTime that specifies the date and time when the current password was set\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string lastSuccessfulValidationDate: description: "A DateTime that specifies the date and time when last successful password validation was set\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: dateTime\n - uniqueness: none" type: string mustChange: description: "Indicates that the subject password value MUST change on next login. If not changed, typically the account is locked. The value may be set indirectly when the subject's current password expires or directly set by an administrator.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean type: object IdentityPropagationTrusts: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/IdentityPropagationTrust' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppBasedOnTemplate: description: "Application template on which the application is based.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: complex" properties: $ref: description: "URI of the application template.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string lastModified: description: "The most recent DateTime that the appTemplate on which the application based upon is updated. The attribute MUST be a DateTime.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string value: description: "Identifier of the application template.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: always\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string wellKnownId: description: "Unique Well-known identifier used to reference app template.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value type: object AppExtensionRequestableApp: description: Requestable App properties: requestable: description: "Flag controlling whether resource can be request by user through self service console.\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: request\n - type: boolean\n - uniqueness: none" type: boolean type: object MyTrustedUserAgents: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyTrustedUserAgent' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object idcsLastModifiedBy: description: "The User or App who modified the Resource\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" properties: $ref: description: "The URI of the SCIM resource that represents the User or App who modified this Resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "The displayName of the User or App who modified this Resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string ocid: description: "The OCID of the SCIM resource that represents the User or App who modified this Resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "The type of resource, User or App, that modified this Resource\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - User - App type: string value: description: "The ID of the SCIM resource that represents the User or App who modified this Resource\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - value type: object NotificationSettingsFromEmailAddress: description: "From email address to be used in the notification emails\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: complex\n - uniqueness: none" properties: displayName: description: "Display name for the From email address\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string validate: description: "From address verification mode. If postmaster account is available then 'domain' mode is used or entire valid email can be verified using 'email' mode\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" enum: - email - domain type: string validationStatus: description: "Validation status for the From email address\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string" enum: - VERIFIED - PENDING type: string value: description: "Value of the From email address\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string" type: string required: - value - validate type: object SchemaAttributes: description: A complex type that specifies the set of Resource attributes properties: canonicalValues: description: "A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \\\"work\\\", \\\"home\\\".\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array caseExact: description: "Specifies if the String attribute is case-sensitive\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean description: description: "The attribute's human-readable description\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsAddedSinceReleaseNumber: description: "Indicates that the schema has been added since this release number\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string idcsAddedSinceVersion: description: "Indicates that the schema has been added since version\n\n**Deprecated Since: 19.3.3**\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsAllowUpdatesInReadOnlyMode: description: "Set this attribute to True if the resource is eligibal for update while system is in readonly mode.\n\n**Added In:** 2106170416\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsAttributeCacheable: description: "Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \\\"attributesToGet\\\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsAttributeMappable: description: "Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP. If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsAuditable: description: "Specifies whether changes to this attribute value are audited\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsAutoIncrementSeqName: description: "Sequence tracking ID name for the attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" maxLength: 8 type: string idcsCanonicalValueSourceDisplayAttrName: description: "Display name for the canonical value attribute name.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceFilter: description: "Filter to use when getting canonical values for this schema attribute\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceKeyAttrName: description: "Source key attribute for the canonical value.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceResourceType: description: "Specifies the Resource type to read from for dynamic canonical values\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueSourceResourceTypeID: description: "Specifies the Resource type ID to read from for dynamic canonical values\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCanonicalValueType: description: "Type of the canonical value.\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - dynamic - static type: string idcsComplexAttributeNameMappings: description: "Specifies the mapping between external identity source attributes and Oracle Identity Cloud Service complex attributes (e.g. email => emails[work].value)\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SchemaIdcsComplexAttributeNameMappings' type: array idcsCompositeKey: description: "The set of one or more sub attributes' names of a CMVA, whose values uniquely identify an instance of a CMVA\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array idcsCsvAttributeName: description: "The attribute defining the CSV header name for import/export\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsCsvAttributeNameMappings: description: "Csv meta data for those resource type attributes which can be imported / exported from / to csv.\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SchemaIdcsCsvAttributeNameMappings' type: array idcsDefaultValue: description: "Specifies the default value for an attribute. The value must be one from canonicalValues if defined.\n\n**Added In:** 18.1.6\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsDeprecatedSinceReleaseNumber: description: "Indicates that the schema has been deprecated since this release number\n\n**Added In:** 17.3.4\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string idcsDeprecatedSinceVersion: description: "Indicates that the schema has been deprecated since version\n\n**Deprecated Since: 19.3.3**\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsDisplayName: description: "Specifies the user-friendly displayable attribute name or catalog key used for localization\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsDisplayNameMessageId: description: "Localized schema attribute display name for use by UI client for displaying attribute labels\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsExcludeFromUpgradePatch: description: "Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.\n\n**Added In:** 2104150946\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: boolean" type: boolean idcsFeatures: description: "The list of features that require this attribute\n\n**Deprecated Since: 19.1.6**\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" items: enum: - optionalPii - mfa - social - schemaCustomization type: string type: array idcsFetchComplexAttributeValues: description: '**SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none Whether the CMVA attribute will be fetched or not for current resource in AbstractResourceManager update operation before calling data provider update. Default is true. ' type: boolean idcsFromTargetMapper: description: "Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsGenerated: description: "Specifies whether this attribute value was generated\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsICFAttributeType: description: "Maps to ICF data type\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - string - long - char - double - float - integer - boolean - bytes - bigdecimal - biginteger - guardedbytes - guardedstring type: string idcsICFBundleAttributeName: description: "Maps to ICF target attribute name\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsICFRequired: description: "Metadata to identify the ICF required attribute\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete: description: "Specifies whether the readOnly and immutable reference attributes should be ignored when forceDelete=true.\n\n**Added In:** 2104220644\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsIndirectRefResourceAttributes: description: "Specifies the indirectly referenced Resources\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" items: type: string type: array idcsInternal: description: "Specifies whether the schema attribute is for internal use only. Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internalflag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsMapsToSameTargetAttributeNameAs: description: "Contains the canonical name of the other attribute sharing the same idcsTargetAttributeName\n\n**Added In:** 2209122038\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string\n - uniqueness: none" type: string idcsMaxLength: description: "Specifies the maximum length of the attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsMaxValue: description: "Specifies the maximum value of the integer attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer" type: integer idcsMinLength: description: "Specifies the minimum length of the attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsMinValue: description: "Specifies the minimum value of the integer attribute\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: integer" type: integer idcsMultiLanguage: description: "If true, specifies that the attribute can have multiple language values set for the attribute on which this is set.\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsOptionalPiiCanonicalValues: description: "A subset of \\\"canonicalValues\\\" that are not supported when the \\\"optionalPii\\\" feature is disabled in GlobalConfig.\n\n**Deprecated Since: 19.1.6**\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array idcsOverrideCommonAttribute: description: "Specifies whether the attribute from resource schema should override from common schema with the same name.\n\n**Added In:** 2102181953\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsPaginateResponse: description: "Set this attribute to True if the pagination is required on an attribute.\n\n**Added In:** 2202230830\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsPii: description: "Specifies whether the attribute is PII (personal information). False by default for all attributes. If attribute with idcsPii = true, it's value must be obfuscated before it's written to the Oracle Identity Cloud Service system logs.\n\n**Added In:** 18.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsRefResourceAttribute: description: "Specifies the referenced Resource attribute\n\n**Deprecated Since: 17.3.4**\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string idcsRefResourceAttributes: description: "Specifies the directly referenced Resources\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" items: type: string type: array idcsRequiresImmediateReadAfterWriteForAccessFlows: description: "If true, indicates that the attribute value must be written to the home region and requires immediate read-after-write consistency for access flows initiated from a replica region.\n\n**Added In:** 2209220956\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: never\n - type: boolean" type: boolean idcsRequiresWriteForAccessFlows: description: "If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.\n\n**Added In:** 2209220956\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsReturnEmptyWhenNull: description: "Specifies if the attribute is required\n\n**Added In:** 2305190132\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsRtsaHideAttribute: description: "Specifies if the attributes in this schema should be hidden externally\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsSanitize: description: "Specifies if the value of the attribute should be sanitized using OWASP library for HTML content\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsScimCompliant: description: "Indicates if the attribute is scim compliant, default is true\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsSearchable: description: "Specifies whether this attribute can be included in a search filter\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsSensitive: description: "Flag to specify if the attribute should be encrypted or hashed\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - encrypt - hash - hash_sc - checksum - none type: string idcsTargetAttributeName: description: "Target attribute name that this attribute gets mapped to for persistence\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetAttributeNameToMigrateFrom: description: "Old Target attribute name from child table for CSVA attribute prior to migration. This maintains this attribute used to get mapped to for persistence\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetNormAttributeName: description: "Target normalized attribute name that this normalized value of attribute gets mapped to for persistence. Only set for caseExact=false & searchable attributes. Do not use by default.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTargetUniqueConstraintName: description: "Target index name created for this attribute for performance\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsToTargetMapper: description: "Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string idcsTrimStringValue: description: "Trims any leading and trailing blanks from String values. Default is True.\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsValidateReference: description: "Validate payload reference value during create, replace, and update. Default is True.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean idcsValuePersisted: description: "Specifies whether the value of the Resource attribute is persisted\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsValuePersistedInOtherAttribute: description: "If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation\n\n**Added In:** 18.2.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsuiOrder: description: "Metadata used by Oracle Identity Cloud Service UI to sequence the attributes displayed on the Account Form.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer" type: integer idcsuiRegexp: description: "Metadata used by Oracle Identity Cloud Service UI to validate the attribute values using regular expressions.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" type: string idcsuiVisible: description: "Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean idcsuiWidget: description: "Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.\n\n**Added In:** 17.4.2\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string" enum: - inputtext - checkbox - textarea - combobox type: string localizedCanonicalValues: description: "A collection of Localized canonical values.\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SchemaLocalizedCanonicalValues' type: array localizedDisplayName: $ref: '#/components/schemas/SchemaLocalizedDisplayName' multiValued: description: "Indicates the attribute's plurality\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean mutability: description: "Specifies if the attribute is mutable\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - readOnly - readWrite - immutable - writeOnly type: string name: description: "Attribute's name\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string referenceTypes: description: "The names of the Resource types that may be referenced--for example, User. This is only applicable for attributes that are of the \\\"reference\\\" data type.\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array required: description: "Specifies if the attribute is required\n\n**SCIM++ Properties:**\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean" type: boolean returned: description: "A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - always - never - default - request type: string subAttributes: description: "A list specifying the contained attributes\n\n**SCIM++ Properties:**\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex" items: $ref: '#/components/schemas/SchemaSubAttributes' type: array type: description: "The attribute's data type--for example, String\n\n**SCIM++ Properties:**\n - caseExact: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - string - complex - boolean - decimal - integer - dateTime - reference - binary type: string uniqueness: description: "A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has the uniqueness of \\\"none\\\".\n\n**SCIM++ Properties:**\n - caseExact: true\n - multiValued: false\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - none - server - global type: string type: object ExtensionX509IdentityProvider: description: X509 Identity Provider Extension Schema properties: certMatchAttribute: description: "X509 Certificate Matching Attribute\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string crlCheckOnOCSPFailureEnabled: description: "Fallback on CRL Validation if OCSP fails.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean crlEnabled: description: "Set to true to enable CRL Validation\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean crlLocation: description: "CRL Location URL\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string crlReloadDuration: description: "Fetch the CRL contents every X minutes\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer ekuValidationEnabled: description: "Set to true to enable EKU Validation\n\n**Added In:** 2304270343\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean ekuValues: description: "List of EKU which needs to be validated\n\n**Added In:** 2304270343\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: enum: - SERVER_AUTH - CLIENT_AUTH - CODE_SIGNING - EMAIL_PROTECTION - TIME_STAMPING - OCSP_SIGNING type: string maxLength: 256 type: array ocspAllowUnknownResponseStatus: description: "Allow access if OCSP response is UNKNOWN or OCSP Responder does not respond within the timeout duration\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean ocspEnableSignedResponse: description: "Describes if the OCSP response is signed\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean ocspEnabled: description: "Set to true to enable OCSP Validation\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean ocspResponderURL: description: "This property specifies OCSP Responder URL.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 1000 type: string ocspRevalidateTime: description: "Revalidate OCSP status for user after X hours\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - idcsMaxValue: 24\n - idcsMinValue: 0\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: integer\n - uniqueness: none" type: integer ocspServerName: description: "This property specifies the OCSP Server alias name\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 100 type: string ocspTrustCertChain: description: "OCSP Trusted Certificate Chain\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 256 type: array otherCertMatchAttribute: description: "Check for specific conditions of other certificate attributes\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string signingCertificateChain: description: "Certificate alias list to create a chain for the incoming client certificate\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string maxLength: 256 type: array userMatchAttribute: description: "This property specifies the userstore attribute value that must match the incoming certificate attribute.\n\n**Added In:** 2010242156\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 256 type: string required: - certMatchAttribute - userMatchAttribute - signingCertificateChain type: object AccountMgmtInfo: description: Schema for AccountMgmtInfo resource. properties: accountType: description: "Type of Account\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string active: description: "If true, the account is activated\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean app: $ref: '#/components/schemas/AccountMgmtInfoApp' compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string compositeKey: description: "Unique key for this AccountMgmtInfo, which is used to prevent duplicate AccountMgmtInfo resources. Key is composed of a subset of app, owner and accountType.\n\n**Added In:** 18.1.2\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: server" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean doNotBackFillGrants: description: "If true, a back-fill grant will not be created for a connected managed app as part of account creation.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean doNotPerformActionOnTarget: description: "If true, the operation will not be performed on the target\n\n**Added In:** 17.4.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string favorite: description: "If true, this account has been marked as a favorite of the User who owns it\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isAccount: description: "If true, indicates that this managed object is an account, which is an identity that represents a user in the context of a specific application\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean lastAccessed: description: "Last accessed timestamp of an application\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string matchingOwners: description: "Matching owning users of the account\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/AccountMgmtInfoMatchingOwners' type: array meta: $ref: '#/components/schemas/meta' name: description: "Name of the Account\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string objectClass: $ref: '#/components/schemas/AccountMgmtInfoObjectClass' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string operationContext: description: "The context in which the operation is performed on the account.\n\n**Added In:** 19.1.4\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - LifeCycleEvent type: string owner: $ref: '#/components/schemas/AccountMgmtInfoOwner' previewOnly: description: "If true, then the response to the account creation operation on a connected managed app returns a preview of the account data that is evaluated by the attribute value generation policy. Note that an account will not be created on the target application when this attribute is set to true.\n\n**Added In:** 18.2.6\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean resourceType: $ref: '#/components/schemas/AccountMgmtInfoResourceType' schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array syncResponse: description: "Last recorded sync response for the account\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string syncSituation: description: "Last recorded sync situation for the account\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - Found - Matched - Unmatched - Lost - Disputed - Confirmed type: string syncTimestamp: description: "Last sync timestamp of the account\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string uid: description: "Unique identifier of the Account\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string userWalletArtifact: $ref: '#/components/schemas/AccountMgmtInfoUserWalletArtifact' required: - schemas - app type: object GrantApp: description: "Application that is being granted. Each Grant must grant either an App or an App-Entitlement-Collection.\n\n**SCIM++ Properties:**\n - idcsCsvAttributeNameMappings: [[columnHeaderName:App Name, defaultValue:jobParam:appDisplayName, mapsTo:app.value]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: $ref: description: "Application URI\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Application display name\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string value: description: "Application identifier\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object Schemas: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/Schema' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object MyRequests: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyRequest' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object AppIdentityProviders: description: A list of IdentityProvider assigned to app. A user trying to access this app will be automatically redirected to configured IdP during the authentication phase, before being able to access App. properties: $ref: description: "URI of the IdentityProvider.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: reference\n - uniqueness: none" type: string display: description: "Display-name of the IdentityProvider.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string value: description: "ID of the IdentityProvider.\n\n**SCIM++ Properties:**\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 40 minLength: 1 type: string required: - value type: object AuthenticationFactorSettingsThirdPartyFactor: description: "Settings related to third-party factor\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" properties: duoSecurity: description: "To enable Duo Security factor\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean required: - duoSecurity type: object MyAuthenticationFactorValidator: description: Validate any given Authentication Factor properties: additionalAttributes: description: "Additional attributes which will be sent as part of a push notification\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: default\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/MyAuthenticationFactorValidatorAdditionalAttributes' type: array authFactor: description: "Authentication Factor which is being validated\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: true\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" enum: - USERNAME_PASSWORD - PUSH - TOTP - EMAIL - SMS - VOICE - BYPASSCODE - SECURITY_QUESTIONS - TRUST_TOKEN - PHONE_CALL - THIRDPARTY - FIDO_AUTHENTICATOR - YUBICO_OTP - KMSI_TOKEN type: string compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string createKmsiToken: description: "Indicates to create kmsi token.\n\n**SCIM++ Properties:**\n - type: boolean\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: boolean createTrustedAgent: description: "Indicates to create trust token.\n\n**SCIM++ Properties:**\n - type: boolean\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: boolean deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean deviceId: description: "Device id whose factor is being validated\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" type: string displayName: description: "Display name of the verified device\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isAccRecEnabled: description: "Flag indicates whether the factor is enrolled in account recovery. If the value is not provided or false, then it will be treated as MFA factor validation.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean kmsiTokenId: description: "KMSI token resource identifier.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: string location: description: "Location of the trusted client.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: string message: description: "Validator message which is passed by the client. When it is a PUSH notification, it can be a rejection message.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" type: string meta: $ref: '#/components/schemas/meta' name: description: "Name of the client to be trusted\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string otpCode: description: "The One Time Passcode which needs to be validated\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: never\n - uniqueness: none\n - idcsSensitive: encrypt\n - idcsSearchable: false" type: string platform: description: "Platform of the client to be trusted\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: string policyEnabledSecondFactors: description: "Sign-On Policy dictated allowed second factors.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: true\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" items: type: string type: array policyTrustedFrequencyMins: description: "Sign-On Policy dictated validity duration for trusted client in Minutes.\n\n**SCIM++ Properties:**\n - type: integer\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: integer preferenceType: description: "Indicates whether to user passwordless factor to be updated or mfa factor to be updated\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" enum: - PASSWORDLESS - MFA type: string requestId: description: "Request ID which is being validated\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" type: string scenario: description: "Specifies whether the service is being used to enroll or validate a factor\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: true\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" enum: - ENROLLMENT - AUTHENTICATION type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array securityQuestions: description: "List of security questions the user has submitted to get authenticated.\n\n**SCIM++ Properties:**\n - type: complex\n - multiValued: true\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none\n - idcsSearchable: false" items: $ref: '#/components/schemas/MyAuthenticationFactorValidatorSecurityQuestions' type: array status: description: "Validation status returned in the response\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readOnly\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" enum: - SUCCESS - FAILURE type: string tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string thirdPartyFactor: $ref: '#/components/schemas/MyAuthenticationFactorValidatorThirdPartyFactor' trustedTokenId: description: "Trusted token resource identifier.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: string type: description: "type indicating whether the flow is OIDC, SAML etc.,\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: default\n - uniqueness: none" enum: - SAML - OIDC type: string updateUserPreference: description: "Indicates whether to update user preferred mfa factor or not\n\n**SCIM++ Properties:**\n - type: boolean\n - multiValued: false\n - required: false\n - mutability: writeOnly\n - returned: never\n - uniqueness: none" type: boolean userId: description: "User guid for whom the validation has initiated. Optional.\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false" type: string userName: description: "User name for whom the validation has initiated\n\n**SCIM++ Properties:**\n - type: string\n - multiValued: false\n - required: false\n - mutability: readWrite\n - returned: default\n - uniqueness: none\n - idcsSearchable: false\n - idcsPii: true" type: string required: - schemas - authFactor - scenario type: object Group: description: The Group resource. properties: compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean displayName: description: "The Group display name.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Display Name\n - idcsCsvAttributeNameMappings: [[columnHeaderName:Name, deprecatedColumnHeaderName:Display Name]]\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: global" maxLength: 3000 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string externalId: description: "An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array members: description: "The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use 'startIndex' and 'count' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsCsvAttributeNameMappings: [[columnHeaderName:User Members, mapsTo:members[User].value, multiValueDelimiter:;]]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - idcsPaginateResponse: true\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/GroupMembers' type: array meta: $ref: '#/components/schemas/meta' nonUniqueDisplayName: description: "A human readable name for the group as defined by the Service Consumer.\n\n**Added In:** 2011192329\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCsvAttributeName: Non-Unique Display Name\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: always\n - type: string" maxLength: 3000 minLength: 1 type: string ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags: $ref: '#/components/schemas/ExtensionOCITags' urn:ietf:params:scim:schemas:oracle:idcs:extension:dbcs:Group: $ref: '#/components/schemas/ExtensionDbcsGroup' urn:ietf:params:scim:schemas:oracle:idcs:extension:dynamic:Group: $ref: '#/components/schemas/ExtensionDynamicGroup' urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group: $ref: '#/components/schemas/ExtensionGroupGroup' urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group: $ref: '#/components/schemas/ExtensionPosixGroup' urn:ietf:params:scim:schemas:oracle:idcs:extension:requestable:Group: $ref: '#/components/schemas/ExtensionRequestableGroup' required: - schemas - displayName type: object ConditionExtensionOciconsolesignonpolicyconsentPolicy: description: This extension defines attributes used to record consent for modification of the "Security Policy for OCI Console" sign-on policy, Rule, Condition or ConditionGroup. properties: consent: description: "Set to true when an identity domain administrator opts to change the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle. Defaults to false.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: boolean" type: boolean justification: description: "The justification for the change when an identity domain administrator opts to modify the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string" type: string reason: description: "The detailed reason for the change when an identity domain administrator opts to modify the Oracle security defaults for the \"Security Policy for OCI Console\" sign-on policy shipped by Oracle.\n\n**Added In:** 2405220110\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: false\n - mutability: writeOnly\n - required: false\n - returned: never\n - type: string" maxLength: 250 minLength: 5 type: string type: object ExtensionCapabilitiesUser: description: User's Capabilities properties: canUseApiKeys: description: "Indicates whether a user can use API keys.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseAuthTokens: description: "Indicates whether a user can use Auth tokens.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseConsole: description: "Specifies whether user can access the Console.\n\n**Added In:** 2206280902\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseConsolePassword: description: "Indicates whether a user can use Console passwords.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseCustomerSecretKeys: description: "Indicates whether a user can use customer secret keys.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseDbCredentials: description: "Indicates whether a user can use database credentials.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseOAuth2ClientCredentials: description: "Indicates whether a user can use OAuth2 client credentials.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean canUseSmtpCredentials: description: "Indicates whether a user can use SMTP credentials.\n\n**Added In:** 2012271618\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean type: object MyRequestableGroups: description: The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI. properties: Resources: description: A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero. items: $ref: '#/components/schemas/MyRequestableGroup' type: array itemsPerPage: description: The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination. type: integer schemas: description: 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. 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. REQUIRED. items: type: string type: array startIndex: description: The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination. type: integer totalResults: description: The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED. type: integer required: - schemas - totalResults - Resources - startIndex - itemsPerPage type: object NotificationSettingsEventSettings: description: Event settings properties: enabled: description: "Specify if notifications are enabled for the event\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean eventId: description: "IDCS-generated event\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" type: string required: - eventId type: object CloudGate: description: Resource representing a Cloud Gate properties: active: description: "Activation status for this Cloud Gate\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean compartmentOcid: description: "OCI Compartment Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string deleteInProgress: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: boolean\n - uniqueness: none" type: boolean description: description: "Brief description for this Cloud Gate\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" maxLength: 250 minLength: 1 type: string displayName: description: "Display name/Host identifier for this Cloud Gate\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: true\n - returned: always\n - type: string\n - uniqueness: server" maxLength: 250 minLength: 1 type: string domainOcid: description: "OCI Domain Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string id: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: string\n - uniqueness: global" type: string idcsCreatedBy: $ref: '#/components/schemas/idcsCreatedBy' idcsLastModifiedBy: $ref: '#/components/schemas/idcsLastModifiedBy' idcsLastUpgradedInRelease: description: "The release number when the resource was upgraded.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" type: string idcsPreventedOperations: description: "Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.\n\n**SCIM++ Properties:**\n - idcsSearchable: false\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: string\n - uniqueness: none" items: enum: - replace - update - delete type: string x-obmcs-top-level-enum: '#/definitions/IdcsPreventedOperations' type: array isOPCService: description: "Indicates whether this resource was created by OPC\n\n**Added In:** 19.3.3\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: always\n - type: boolean\n - uniqueness: none" type: boolean lastModifiedTime: description: "Last updated timestamp for this CloudGate's servers and mappings.\n\n**Added In:** 19.2.1\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: true\n - multiValued: false\n - mutability: readWrite\n - required: false\n - returned: default\n - type: dateTime\n - uniqueness: none" maxLength: 100 type: string mappings: description: "A list of Cloud Gate Mappings that map Apps to this Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [serverId, resourcePrefix]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/CloudGateExtMappings' type: array meta: $ref: '#/components/schemas/meta' oauthClient: $ref: '#/components/schemas/CloudGateOauthClient' ocid: description: "Unique OCI identifier for the SCIM Resource.\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsSearchable: true\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: global" maxLength: 255 type: string schemas: description: "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.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: true\n - mutability: readWrite\n - required: true\n - returned: default\n - type: string\n - uniqueness: none" items: type: string type: array servers: description: "A list of Server Blocks on this Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: true\n - idcsCompositeKey: [hostName]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/CloudGateExtServers' type: array tags: description: "A list of tags on this resource.\n\n**SCIM++ Properties:**\n - idcsCompositeKey: [key, value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readWrite\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/tags' type: array tenancyOcid: description: "OCI Tenant Id (ocid) in which the resource lives.\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: readOnly\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" type: string type: description: "Type of Cloud Gate\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsSearchable: false\n - multiValued: false\n - mutability: immutable\n - required: false\n - returned: default\n - type: string\n - uniqueness: none" enum: - lbaas - gateway type: string upstreamServerGroups: description: "A list of upstream server groups\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/CloudGateExtUpstreamServerGroups' type: array upstreamServers: description: "A list of upstream servers\n\n**Added In:** 20.1.3\n\n**SCIM++ Properties:**\n - caseExact: false\n - idcsCompositeKey: [value]\n - idcsSearchable: true\n - multiValued: true\n - mutability: readOnly\n - required: false\n - returned: request\n - type: complex\n - uniqueness: none" items: $ref: '#/components/schemas/CloudGateExtUpstreamServers' type: array required: - schemas - displayName type: object parameters: PaginationLimitQueryParam: description: The maximum number of items to return in a paginated 'List' call. in: query name: limit schema: type: integer default: 50 maximum: 1000 minimum: 1 SortOrderQueryParam: description: A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See ([Sorting Section](https://tools.ietf.org/html/draft-ietf-scim-api-19#section-3.4.2.3)). OPTIONAL. in: query name: sortOrder required: false x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING PaginationTokenQueryParam: description: The value of the `opc-next-page` response header from the previous 'List' call. in: query name: page schema: type: string maxLength: 512 minLength: 1 AttributeSetsQueryParam: description: 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. in: query name: attributeSets required: false x-default-description: 'null' schema: type: array items: enum: - all - always - never - request - default type: string x-obmcs-top-level-enum: '#/definitions/AttributeSets' x-obmcs-sdk-identifier-renaming-config: languages: oracle-java-sdk: properties: - mapping: identifier: ruleReturn javaGetter: getRuleReturn originalName: return