User Roles

View, update and manage user roles in your account or your client accounts.

GET /users/{id}/roles

DescriptionGet a list of the user’s roles in your company or client account.
Permissionsuser.manage
Resource URLhttps://app.klipfolio.com/api/1.0/users/{id}/roles
Parametersuser id={id}
optional: client_id

Example Request

GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles
GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles?client_id=0123456789abcdef0123456789abcdef

Example 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}

DescriptionAssign a user to a role in your company or client account.
Permissionsuser.manage
Resource URLhttps://app.klipfolio.com/api/1.0/users/{id}/roles/{id}
Parametersuser 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=0123456789abcdef0123456789abcdef

Example Response

{
  "meta": {
     "status": 200,
     "success": true
 }
}

DELETE /users/{id}/roles/{id}

DescriptionDelete the user from a specified role in your company or client account.
Permissionsuser.manage
Resource URLhttps://app.klipfolio.com/api/1.0/users/{id}/roles{roleid}
Parametersuser id={id}, roles id={id}
optional: client_id

Example Request

DELETE https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles/abcdef123456
DELETE https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles/abcdef123456?client_id=0123456789abcdef0123456789abcdef

Example Response

{
"meta": {
      "status": 200,
      "success": true
  }
}