Get a schema
get
/hcmRestApi/scim/Schemas/{id}
Get a schema
Request
Path Parameters
-
id(required): string
The unique identifier of the schema.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : Schemas-item
Type:
Show Source
object
-
attributes: array
Attributes
Title:
Attributes
The attributes of the schema. -
description: string
Title:
Description
The description of the schema. -
id: string
Title:
Id
The unique identifier of the schema in Oracle Applications Cloud. -
meta: object
Meta
Title:
Meta
The metadata of the schema. -
name: string
Title:
Name
The name of the schema. -
schemas: array
Schemas
Title:
Schemas
The schema value of the schema resource.
Nested Schema : Meta
Type:
object
Title:
Meta
The metadata of the schema.
Nested Schema : Schemas
Type:
array
Title:
Schemas
The schema value of the schema resource.
Show Source
Nested Schema : attributes-item
Type:
Show Source
object
-
caseExact: boolean
Title:
CaseExact
Indicates whether the attribute name is case sensitive. The default value is false. -
description: string
Title:
Description
The attribute description. -
multiValued: boolean
Title:
MultiValued
Indicates whether the attribute contains multiple values, for example multiple email ids. The default value is false. -
mutability: string
Title:
Mutability
The mutability of the attribute. The default value is readWrite. -
name: string
Title:
Name
The attribute name. -
required: boolean
Title:
Required
Indicates whether the attribute is required. The default value is false. -
returned: string
Title:
Returned
Specifies whether the attribute value is returned in response to a query. The default value is default to indicate that the attribute value is returned. -
subAttributes: array
subAttributes
Title:
subAttributes
The sub-attributes of the attribute. -
type: string
Title:
Type
The attribute data type. -
uniqueness: string
Title:
Uniqueness
Specifies the uniqueness of the attribute value. The default value is none to indicate that the values are not unique.
Nested Schema : subAttributes
Type:
array
Title:
subAttributes
The sub-attributes of the attribute.
Show Source
Nested Schema : subattributes-item
Type:
Show Source
object
-
caseExact: boolean
Title:
CaseExact
Indicates whether the sub-attribute name is case sensitive. The default value is false. -
description: string
Title:
Description
The sub-attribute description. -
multiValued: boolean
Title:
MultiValued
Indicates whether the sub-attribute contains multiple values. The default value is false. -
mutability: string
Title:
Mutability
The mutability of the sub-attribute. The default value is readWrite. -
name: string
Title:
Name
The sub-attribute name. -
required: boolean
Title:
Required
Indicates whether the sub-attribute is required. The default value is false. -
type: string
Title:
Type
The sub-attribute data type.
Examples
The following example shows how to retrieve a schema by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Schema/urn:scim:schemas:core:2.0:User
Example of Response Header
The following shows an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "id": "urn:scim:schemas:core:2.0:User", "meta": { "resourceType": "Schema", "created": "2010-01-23T04:56:22Z", "lastModified": "2014-02-04T00:00:00Z", "location": "http://<host>:<port>/hcmRestApi/scim/Schemas/urn:scim:schemas:core:2.0:User", "version": "W/\"3694e05e9dff596\"" }, "schemas": [ "urn:scim:schemas:core:2.0:Schema" ], "name": "User", "description": "Fusion Application User ", "attributes": [ { "name": "id", "type": "String", "description": "A unique identifier for the user, which is defined by the web service provider.", "mutability": "readOnly", "multiValued": false, "required": false, "caseExact": true }, { "name": "externalId", "type": "String", "description": "An external identifier for the user, which is defined by the web service consumer.", "mutability": "readWrite", "multiValued": false, "required": false, "caseExact": true }, { "name": "userName", "type": "String", "description": "A unique identifier for the user that is used to authenticate with the service provider, directly. This attribute is mandatory. ", "mutability": "readWrite", "multiValued": false, "required": true, "caseExact": true }, { "name": "name", "type": "complex", "description": "The components of user’s name. This attribute may return: full name as a single string. individual component attributes. both variants. The formatted version indicates how the component attributes are combined so that both variants describe the same name.", "mutability": "readWrite", "subAttributes": [ { "name": "familyName", "type": "String", "description": "The last name of the user.", "mutability": "readWrite", "multiValued": false, "required": false, "caseExact": true }, { "name": "givenName", "type": "String", "description": "The first name of the user.", "mutability": "readWrite", "multiValued": false, "required": false, "caseExact": true } ], "multiValued": false, "required": false, "caseExact": true }, { "name": "displayName", "type": "String", "description": "The display name of the user, which should include all the available component attributes.", "mutability": "readWrite", "multiValued": false, "required": false, "caseExact": true }, { "name": "preferredLanguage", "type": "String", "description": "The preferred language of the user, which is used to select a localized user interface. For example, use en_US to specify English as the language and US as the country. ", "mutability": "readWrite", "multiValued": false, "required": false, "caseExact": true }, { "name": "active", "type": "boolean", "description": "Indicates the administrative status of the user. The service provider determines the definitive value for this attribute. If the value is true, then the user is able to login. If the value is false, then the user account is suspended. ", "mutability": "readWrite", "multiValued": false, "required": false, "caseExact": true }, { "name": "emails", "type": "complex", "description": "The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, bjensen@example.com instead of bjensen@EXAMPLE.COM. ", "mutability": "readWrite", "subAttributes": [ { "name": "value", "type": "string", "description": "The e-mail address of the user.", "mutability": "readWrite", "multiValued": false, "required": false, "caseExact": true }, { "name": "primary", "type": "boolean", "description": "Indicates that this e-mail id is the primary address. This value is hard coded to true.", "mutability": "readOnly", "multiValued": false, "required": false, "caseExact": true }, { "name": "type", "type": "string", "description": "The type of e-mail id, which is hard coded to work.", "mutability": "readOnly", "multiValued": false, "required": false, "caseExact": true } ], "multiValued": true, "required": false, "caseExact": true }, { "name": "roles", "type": "complex", "description": "The list of roles for users in Oracle Applications Cloud.", "mutability": "readOnly", "subAttributes": [ { "name": "id", "type": "string", "description": "A list of ids for the roles that a user can belong to, through direct membership.", "mutability": "readOnly", "multiValued": false, "required": false, "caseExact": true }, { "name": "value", "type": "string", "description": "A list of values for the roles.", "mutability": "readOnly", "multiValued": false, "required": false, "caseExact": true }, { "name": "displayName", "type": "string", "description": "The display name of the role, as used in related screens.", "mutability": "readOnly", "multiValued": false, "required": false, "caseExact": true }, { "name": "description", "type": "string", "description": "The description of the role.", "mutability": "readOnly", "multiValued": false, "required": false, "caseExact": true } ], "multiValued": true, "required": false, "caseExact": true } ] }