1. REST API for Common Features in Oracle Fusion Cloud Applications
  2. Tasks
  3. Users

Get all users

get

/hcmRestApi/scim/Users

Get all users

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The following table describes the response for this task.
Body ()
Root Schema : Users
Type: object
Show Source
  • Title: Count
    The number of resource instances returned in the current range.
  • Resources
    Title: Resources
    The user resources in the collection.
  • Title: start index
    This parameter defines 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.
Nested Schema : Resources
Type: array
Title: Resources
The user resources in the collection.
Show Source
Nested Schema : Users-item
Type: object
Show Source
  • Title: Active
    Indicates the administrative status of the user. The service provider determines the definitive value for this attribute. For example, true indicates that the user is able to login, and false indicates that the user account is suspended.
  • Title: DisplayName
    The display name of the user, usually the full name.
  • Emails
    Title: Emails
    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. Canonical type values are work, home, and other.
  • Title: Id
    Read Only: true
    A unique identifier for the user resource in Oracle Fusion Cloud Applications.
  • Meta
    Title: Meta
    The metadata of the user resource.
  • Name
    Title: Name
    The components of the 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.
  • Title: Password
    The clear text password of the user. This attribute is used to specify an initial password for new users and to reset password for existing users. The password attribute is never returned in response to a query.
  • Roles
    Title: Roles
    The list of roles for users in Oracle Fusion Cloud Applications.
  • Schemas
    Title: Schemas
    The schema of the user resource.
  • faUser-item
  • Title: UserName
    A unique identifier for the user to authenticate with the service provider directly. This attribute is required.
Nested Schema : Emails
Type: array
Title: Emails
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. Canonical type values are work, home, and other.
Show Source
Nested Schema : Meta
Type: object
Title: Meta
The metadata of the user resource.
Nested Schema : Name
Type: object
Title: Name
The components of the 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.
Nested Schema : Roles
Type: array
Title: Roles
The list of roles for users in Oracle Fusion Cloud Applications.
Show Source
Nested Schema : Schemas
Type: array
Title: Schemas
The schema of the user resource.
Show Source
Nested Schema : faUser-item
Type: object
Show Source
  • Title: AccountType
    Read Only: true
    The account type of a user to indicate person or party association.
  • Title: AssignServiceAdminRoles
    Indicates if the service admin roles are assigned to the user. You can use this attribute to assign ORA_FND_DIAG_ADMINISTRATOR_JOB, ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB, and ORA_FND_IT_SECURITY_MANAGER_JOB admin roles when you create or update a user.
  • PartyInformation
    Title: PartyInformation
    The party information associated with the user.
  • Title: UserCategory
    A user is associated with only one category, at any given time. The default user category value is DEFAULT.
  • WorkerInformation
    Title: WorkerInformation
    The worker information associated with the user.
Nested Schema : email-item
Type: object
Show Source
  • Title: Primary
    Indicates that this e-mail id is the primary address. This value is hard coded to true.
  • Title: Type
    The type of e-mail id, which is hard coded to work.
  • Title: Value
    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. Canonical type values are work, home, and other.
Nested Schema : role-item
Type: object
Show Source
  • Title: Description
    Read Only: true
    The description of the role.
  • Title: DisplayName
    Read Only: true
    The display name of the role.
  • Title: Id
    Read Only: true
    A list of ids for the roles that a user can belong to, through direct membership.
  • Title: Value
    Read Only: true
    A list of values for the roles.
Nested Schema : PartyInformation
Type: array
Title: PartyInformation
The party information associated with the user.
Show Source
Nested Schema : WorkerInformation
Type: array
Title: WorkerInformation
The worker information associated with the user.
Show Source
Nested Schema : partyInformation-item
Type: object
Show Source
  • Title: PartyNumber
    Read Only: true
    The party number associated with the user.
  • Title: Party Usage
    Read Only: true
    The party usage associated with the user, for example, Supplier Contact,Partner Contact, and Customer Contact.
Nested Schema : workerInformation-item
Type: object
Show Source
Back to Top

Examples

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

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": 10000,
  "startIndex": 1,
  "Resources": [
    {
   "id": "C2A28F8ED9FA377A20C8E3D614936E88",
   "meta": {
  "created": "2015-12-09 21:02:44.000",
  "lastModified": "2016-10-20 10:54:56.029",
  "location": "http://<host>:<port>/hcmRestApi/scim/Users/C2A28F8ED9FA377A20C8E3D614936E88"
   },
   "schemas": [
  "urn:scim:schemas:core:2.0:User"
   ],
   "userName": "ZFRCE0543_John",
   "name": {
  "familyName": "Kyle",
  "givenName": "John"
   },
   "displayName": "John Kyle",
   "emails": [
  {
    "value": "John.K@oracle.com",
    "type": "W",
    "primary": true
  }
   ],
   "roles": [
  {
    "id": "40C4AE052EC2582286A6A0FB1514656C",
    "value": "ORA_PER_EMPLOYEE_ABSTRACT",
    "displayName": "Employee",
    "description": "Identifies the person as an employee."
  },
  {
    "id": "05E9F3576995F83E74EB3818FDCA8639",
    "value": "ORA_PER_LINE_MANAGER_ABSTRACT",
    "displayName": "Line Manager",
    "description": "Identifies the person as a line manager."
  }
   ],
   "active": true
 },
 ......
 ......
 ......
  ]
}
Back to Top