Users and roles
List the people who use the Company Portal, enable, disable or re-invite them, and read the roles and permissions that control what each user can do.
Paths are relative to https://api.rushhourapp.com/api/v1. See the API reference overview for how to read each entry.
Users
| Method | Path | Summary |
|---|---|---|
GET | /Settings/Users | List the users of your company. |
GET | /Settings/Users/{id} | Get a user. |
DELETE | /Settings/Users/{id} | Delete user. |
PUT | /Settings/Users/{id}/disable | Disable user. |
PUT | /Settings/Users/{id}/enable | Enable user. |
POST | /Settings/Users/{id}/Invite | Send a user their invitation email. |
GET /Settings/Users
List the users of your company.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
disabledUsers | query | boolean | No | Default: false. |
Also accepts the shared list parameters.
Response: envelope; data is array of CompanyUser.
GET /Settings/Users/{id}
Get a user.
Required access: the Users tab - view/edit/add users permission.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Response: envelope; data is CompanyUser.
DELETE /Settings/Users/{id}
Delete user.
Required access: the Company Admin role.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Response: envelope; data has no documented shape.
PUT /Settings/Users/{id}/disable
Disable user.
Required access: the Users tab - view/edit/add users permission.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Response: envelope; data has no documented shape.
PUT /Settings/Users/{id}/enable
Enable user.
Required access: the Users tab - view/edit/add users permission.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Response: envelope; data has no documented shape.
POST /Settings/Users/{id}/Invite
Send a user their invitation email.
Required access: the Users tab - view/edit/add users permission.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Response: envelope; data has no documented shape.
Roles
| Method | Path | Summary |
|---|---|---|
GET | /Roles | Get roles. |
GET /Roles
Get roles.
Required access: the Company Admin role.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ItemsPerPage | query | integer (int32) | No | |
Page | query | integer (int32) | No | |
SearchTerm | query | string | No | |
SortBy | query | string | No | |
SortDirection | query | integer (int32) | No | One of: 0 (Ascending), 1 (Descending). |
Response: envelope; data is RoleDtoPagedList.
Permissions
| Method | Path | Summary |
|---|---|---|
GET | /Permissions | List permissions. |
GET | /Permissions/CurrentRolesPermissions | List the permissions granted by the signed-in user's roles. |
GET | /Permissions/CurrentRolesWithPermissions | List the signed-in user's roles and the permissions each role grants. |
GET /Permissions
List permissions.
Required access: the Company Admin role.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ItemsPerPage | query | integer (int32) | No | |
Page | query | integer (int32) | No | |
SearchTerm | query | string | No | |
SortBy | query | string | No | |
SortDirection | query | integer (int32) | No | One of: 0 (Ascending), 1 (Descending). |
Response: envelope; data is array of PermissionDto.
GET /Permissions/CurrentRolesPermissions
List the permissions granted by the signed-in user's roles.
Response: envelope; data is array of string.
GET /Permissions/CurrentRolesWithPermissions
List the signed-in user's roles and the permissions each role grants.
Response: envelope; data is array of PermissionDto.