GET /users
Retrieve a list of users in your organization.
Query Parameters
where | The OCNQL search expression or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts created on or after 'Jan 15, 2014’, the search expression will be where=createdDate >= ‘2014-01-15’. When this parameter is omitted, all accounts are returned in a paginated fashion. |
nextPage | The next page token. Found in the header of the previous search |
pageSize | The page size for the paginated results, defaults to 200 |
Response Fields
Name | Description |
---|---|
IDid | The unique identifier for a user within an account. Use in any /users endpoint with an {id} variable. |
CreatedcreatedDate | The date when someone created the account. |
First NamefirstName | The first name of the user. |
Last NamelastName | The last name of the user. |
password | A placeholder for the user's secure password. |
Emailemail | The email address of the user. The email receives all password reset emails. |
Activeactive | Indicates if the account is active. In the JSON response, true is active and false is inactive. |
User Secretsecret | The User Secret required for API calls to SAP Open Connectors APIs. You can also find your User Secret in the profile menu in SAP Open Connectors. |
lastLoginDate | The date that the user last logged in to SAP Open Connectors, or the date that someone created the account . |
fullName | The first and last name of the user. |
Org Admin/Account Adminroles | The roles assigned to the user. |
Example Request
curl -X GET \
https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/users?where=active%3D%true%60&pageSize=100 \
-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
-H 'Content-Type: application/json' \
Example Response
[
{
"id":3805,
"createdDate":"2017-07-10",
"firstName":"Neta",
"password":"secured",
"email":"Alfaro@mycompany.com",
"active":true,
"lastName":"Alfaro",
"accountExpired":false,
"accountLocked":false,
"credentialsExpired":true,
"lastLoginDate":"2017-07-10",
"emailValid":true,
"accountNonExpired":false,
"credentialsNonExpired":false,
"accountNonLocked":true,
"enabled":false,
"fullName":"Neta Alfaro"
}
]