Create Roles
Use this API to create a new role.
Resource URL
https://<subdomain>/api/2/roles
Header Parameters
Authorization required string | Set to Set 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: |
Content-Type required string |
Set to application/json . |
Request Parameters
name required string |
The name of the role. |
apps array |
A list of app IDs that will be assigned to the role. E.g. [234, 567, 777] |
users array |
A list of user IDs to assign to the role. |
admins array |
A list of user IDs to assign as role administrators. |
Sample Responses
- 201 Created
- 401 Unauthorized
[
{
"id": 123,
}
]
Typically, this error means that your access token value is invalid.
{
"message": "Unauthorized",
"statusCode": 401,
"name": "UnauthorizedError"
}
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.
Create Role
curl 'https://<subdomain>/api/2/roles' \
-X POST \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"name":"<role name>"
}'
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.