View, update and manage user roles in your account or your client accounts.
GET /users/{id}/roles
| Description | Get a list of the user’s roles in your company or client account. |
| Permissions | user.manage |
| Resource URL | https://app.klipfolio.com/api/1.0/users/{id}/roles |
| Parameters | user id={id} optional: client_id |
Example Request
GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/rolesGET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles?client_id=0123456789abcdef0123456789abcdefExample Response
{
"data": {
"id":"fedcba9876543210fedcba9876543210",
"name":"Admin",
"description":"Manage all assets, users, groups, roles, and account settings."
},
"meta": {
"status": 200,
"success": true
}
}
PUT /users/{id}/roles/{id}
| Description | Assign a user to a role in your company or client account. |
| Permissions | user.manage |
| Resource URL | https://app.klipfolio.com/api/1.0/users/{id}/roles/{id} |
| Parameters | user id={id}, roles id={id} optional: client_id |
Example Request
PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles/abcdef123456
-d {'id': ['f70a1cd9817b85ffa252a7b4280f0223’]}PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles/abcdef123456?client_id=0123456789abcdef0123456789abcdefExample Response
{
"meta": {
"status": 200,
"success": true
}
}
DELETE /users/{id}/roles/{id}
| Description | Delete the user from a specified role in your company or client account. |
| Permissions | user.manage |
| Resource URL | https://app.klipfolio.com/api/1.0/users/{id}/roles{roleid} |
| Parameters | user id={id}, roles id={id} optional: client_id |
Example Request
DELETE https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles/abcdef123456DELETE https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles/abcdef123456?client_id=0123456789abcdef0123456789abcdefExample Response
{
"meta": {
"status": 200,
"success": true
}
}