Users
The information in this document is currently in BETA and subject to change.
The Users resource is a Read-Only resource that represents system users (participants with access to the system). This information is mix of contact details that are general across all systems the end user may have access to, and setting details that can only be managed by an Administrator in the access system.
In order to retrieve the User resource object for the current accessing user, use the resource identifier "current".
returns the User resource for the current accessing user
GET /users/current
Resource Properties
| Scope Parameter | users |
|---|---|
| Location | /users |
| Methods | GET |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
Resource Attributes
| Field | Description | Format | Required | Field Type | Notes |
|---|---|---|---|---|---|
| isCurrent | Indicates if the User resource is that of the current accessing user. | boolean | false | default | |
| emailAddress | The end user's email address. | string | true | default | This is the email address they use to login into Actionstep and general to all system they have access to. |
| isActive | If the end user is active. | boolean | true | default | |
| hasAuthority | If the user has authority to make billing changes. | boolean | true | default | |
| participant | The associated participants resource for the end user. | string | true | link | |
| role | The associated roles resource for the end user. | string | true | link | |
| division | The associated divisions resource for the end user. | string | true | link | |
| defaultRate | The associated rates resource for the end user. | string | false | link | |
| rate | The associated rates resource for the end user. | string | false | link | |
| defaultUtbmsTimekeeperCode | The associated utbmscodes resource for the end user. | string | false | link |
Menu Permissions
Include the "roles" link template to find out what menu items the current user has access to and set these accordingly in your app.
.../api/rest/user/current?include=role
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| users.participant | participants | /participants/{users.participant} |
| users.role | roles | /roles/{users.role} |
| users.division | divisions | /divisions/{users.division} |
| users.defaultRate | rates | /rates/{users.defaultRate} |
| users.rate | rates | /rates/{users.rate} |
| users.defaultUtbmsTimekeeperCode | utbmscodes | /utbmscodes/{users.defaultUtbmsTimekeeperCode |