Get all roles

get

/hcmRestApi/scim/Roles

Request

Query Parameters
  • This parameter specifies a comma-separated list of attribute values to be included in the response.
  • This parameter specifies the number of resource instances to be returned in the current range.
  • This parameter specifies the query expression to retrieve a subset of user resource instances. Format: ?filter= Example: filter=firstName pr and userType eq Employee.
  • 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=active
  • This parameter specifies the attributes based on which the resource collection is ordered. Example: sortOrder=ascending
  • This parameter specifies use of 1-based index for the first result included in the response. Specify this query parameter to use pagination.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : Roles
Type: object
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The roles in the collection.
Show Source
Nested Schema : Roles-item
Type: object
Show Source
Nested Schema : Members
Type: array
Title: Members
A list of users assigned to the role.
Show Source
Nested Schema : meta
Type: array
Title: meta
The metadata of the roles resource.
Show Source
Nested Schema : Schemas
Type: array
Title: Schemas
The schema of the roles resource.
Show Source
Nested Schema : members-item
Type: object
Show Source
Nested Schema : meta-item
Type: object
Show Source
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