See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Roles >
  5. Add Role Users

Add Role Users

Use this API to add users to a role.









Resource URL

https://<subdomain>/api/2/roles/:id/users

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Content-Type

required

string

 Set to application/json.

Request Parameter

user_id

required

array

Set user_id values in array, for example: [123, 456, 678]

Sample Responses

  • 200 Ok
  • 401 Unauthorized
  • 422 Unprocessable Entity
[
  {
      "id": 123,
  }
]

Typically, this error means that your Authorization header value is missing or incorrectly formatted. The Authorization header value should use this format: bearer:<access_token>.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

Indicates that the syntax of the request is good but a value supplied is not valid.

{
    "message": "Validation failed: The associated Policy with ID 0 could not be found",
    "statusCode": 422,
    "name": "UnprocessableEntityError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for Roles API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Add Roles Users

curl 'https://<subdomain>/api/2/roles/:id/users' \
-X POST \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json" \
-d '[123, 456, 789]'

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.