Assigns roles to a user
Path parameters
userIdstringRequired
The id of the user to assign the roles to.
Query parameters
roleIdsstring[]Required
The role ids to assign.
Header parameters
Brand-URLstringRequiredExample:
The brand URL of the request. This is used to identify the brand.
YOUR_BRAND_URL
Auth-KeystringRequiredExample:
This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.
YOUR_AUTH_KEY
Responses
200
The request was successful.
application/json
403
The user's access was denied.
application/json
404
The user was not found in the database.
application/json
429
The user has exceeded the rate limit.
application/json
post
POST /api/v1/users/{userId}/roles HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*
{
"success": true,
"statusCode": 200,
"message": "The request was successful.",
"data": true,
"errors": []
}
Last updated
Was this helpful?