Jump to

• Request
• Response
• Examples

Get all roles

get

/hcmRestApi/scim/Roles

Get all roles

Request

Query Parameters

• attributes: string
  This parameter specifies a comma-separated list of attribute values to be included in the response.
• count: integer
  This parameter specifies the number of resource instances to be returned in the current range.
• filter: string
  This parameter specifies the query expression to retrieve a subset of resource instances. Format: ?filter=Example: filter=firstName pr and userType eq Employee
• sortBy: string
  This parameter specifies the attributes based on which the resource collection is sorted.Format: ?sortBy= where the attribute name must be of the format for simple attributes and for complex attributes.Example: sortBy=category
• sortOrder: string
  This parameter specifies the attributes based on which the resource collection is ordered.Example: sortOrder=ascending
• startIndex: integer
  This parameter specifies use of 1-based index for the first result included in the response. Specify this query parameter to use pagination.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : Roles

Type: object

Show Source

• itemsPerPage: integer
  Title: Count

  The number of resource instances returned in the current range.
• Resources: array Resources
  Title: Resources

  The roles in the collection.
• startIndex: integer
  Title: start index

  The starting position in the resource collection. For example, if startIndex is 11 and itemsPerPage is 10, the response body contains rows from 11 to 20.

{
    "type":"object",
    "properties":{
        "itemsPerPage":{
            "title":"Count",
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "startIndex":{
            "title":"start index",
            "type":"integer",
            "description":"The starting position in the resource collection. For example, if startIndex is 11 and itemsPerPage is 10, the response body contains rows from 11 to 20."
        },
        "Resources":{
            "title":"Resources",
            "type":"array",
            "description":"The roles in the collection.",
            "items":{
                "$ref":"#/components/schemas/Roles-item"
            }
        }
    }
}

Nested Schema : Resources

Type: array

Title: Resources

The roles in the collection.

Show Source

• Array of: object Roles-item

{
    "title":"Resources",
    "type":"array",
    "description":"The roles in the collection.",
    "items":{
        "$ref":"#/components/schemas/Roles-item"
    }
}

Nested Schema : Roles-item

Type: object

Show Source

• category: string
  Title: Category

  The category of the role, for example Manager.
• description: string
  Title: Description

  The description of the role, which includes informations such as the functions that a user with this role can perform.
• displayName: string
  Title: DisplayName

  The display name for the role.
• id: string
  Title: Id

  A unique identifier for the role in Oracle Applications Cloud.
• members: array Members
  Title: Members

  A list of users assigned to the role.
• meta: object meta
  Title: meta

  The metadata of the roles resource.
• name: string
  Title: Name

  The name of the role.
• schemas: array Schemas
  Title: Schemas

  The schema of the roles resource.

{
    "type":"object",
    "properties":{
        "schemas":{
            "title":"Schemas",
            "type":"array",
            "description":"The schema of the roles resource.",
            "items":{
                "type":"string"
            }
        },
        "meta":{
            "title":"meta",
            "type":"object",
            "description":"The metadata of the roles resource."
        },
        "id":{
            "title":"Id",
            "type":"string",
            "description":"A unique identifier for the role in Oracle Applications Cloud."
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the role."
        },
        "displayName":{
            "title":"DisplayName",
            "type":"string",
            "description":"The display name for the role."
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the role, which includes informations such as the functions that a user with this role can perform."
        },
        "category":{
            "title":"Category",
            "type":"string",
            "description":"The category of the role, for example Manager."
        },
        "members":{
            "title":"Members",
            "type":"array",
            "description":"A list of users assigned to the role.",
            "items":{
                "$ref":"#/components/schemas/members-item"
            }
        }
    }
}

Nested Schema : Members

Type: array

Title: Members

A list of users assigned to the role.

Show Source

• Array of: object members-item

{
    "title":"Members",
    "type":"array",
    "description":"A list of users assigned to the role.",
    "items":{
        "$ref":"#/components/schemas/members-item"
    }
}

Nested Schema : meta

Type: object

Title: meta

The metadata of the roles resource.

Nested Schema : Schemas

Type: array

Title: Schemas

The schema of the roles resource.

Show Source

• Array of: string

{
    "title":"Schemas",
    "type":"array",
    "description":"The schema of the roles resource.",
    "items":{
        "type":"string"
    }
}

Nested Schema : members-item

Type: object

Show Source

• operation: string
  Title: Operation

  The operation to be performed in the PATCH request.
• value: string
  Title: Value

  The unique identifier of the user assigned to the role.

{
    "type":"object",
    "properties":{
        "operation":{
            "title":"Operation",
            "type":"string",
            "description":"The operation to be performed in the PATCH request."
        },
        "value":{
            "title":"Value",
            "type":"string",
            "description":"The unique identifier of the user assigned to the role."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all the roles 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/Roles

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:

{
  "itemsPerPage": 500,
  "startIndex": 1,
  "Resources": [
    {
      "id": "6FC956208A6A4E87A1F57E76F08D1616",
      "meta": {
        "created": "2016-09-08 12:05:09.192",
        "lastModified": "2016-10-19 04:58:45.278",
        "location": "http://<host>:<port>/hcmRestApi/scim/Roles/6FC956208A6A4E87A1F57E76F08D1616"
      },
      "schemas": [
        "urn:oracle:apps:scim:schemas:fa:1.0:Role"
      ],
      "name": "DATA_ROLE_TEST_1.1160908_115907_DATA",
      "displayName": "data role test 1.1160908_115907",
      "description": "data role test 1.1160908_115907 Data",
      "category": "DATA",
      "members": [
        {
          "value": "3BBE77DF8A0FF8F2E050F00A081B2E54"
        }
      ]
    },
    {
      "id": "913BCD5BE7C54062A88A14A54E42A7B0",
      "meta": {
        "created": "2016-09-15 13:50:35.809",
        "lastModified": "2016-10-19 04:58:49.097",
        "location": "http://<host>:<port>/hcmRestApi/scim/Roles/913BCD5BE7C54062A88A14A54E42A7B0"
      },
      "schemas": [
        "urn:oracle:apps:scim:schemas:fa:1.0:Role"
      ],
      "name": "DATA_ROLE_TEST_1.1160915_134459_DATA",
      "displayName": "data role test 1.1160915_134459",
      "description": "data role test 1.1160915_134459 Data",
      "category": "DATA",
      "members": [
        {
          "value": "3BBE77930627B046E050F00A081B2DD3"
        }
      ]
    },
 .....
 .....
 ]
}

Back to Top