Replace User Roles

POST /users/{userName}/roles
Bearer auth

This API call is used to replace all user roles with specified roles. Please refer to the users_roles_schema below to get the list of assignable roles.

Path parameters

  • userName string Required

    Username or ID of the user.

application/json

Body object Required

One of:
object-1 object object-2 object object-3 object

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
  • 400 application/json

    Failure Response

    Hide response attributes Show response attributes object
  • 401 application/json

    Authentication Error. Invalid credentials.

    Hide response attributes Show response attributes object
  • 403

    Authorization Error. Invalid role for request.

  • 404 application/json

    User Not Found

    Hide response attributes Show response attributes object
POST /users/{userName}/roles 
curl \
 --request POST 'https://localhost:8080/users/testuser1/roles' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '[{"type":"Close","value":"CloseAdmin"},{"type":"Certification","value":"Reconciler"},{"type":"Certification","value":"ProgramAdmin"},{"type":"JournalEntry","value":"Preparer"}]'
Request example 
[
  {
    "type": "Close",
    "value": "CloseAdmin"
  },
  {
    "type": "Certification",
    "value": "Reconciler"
  },
  {
    "type": "Certification",
    "value": "ProgramAdmin"
  },
  {
    "type": "JournalEntry",
    "value": "Preparer"
  }
]
Response examples (200) 
{
  "status": "Success",
  "messages": [
    "User roles added successfully"
  ]
}
Response examples (400) 
{
  "code": "00009",
  "errors": [
    "Invalid value for role type. Allowable values: Certification, Close, JournalEntry"
  ],
  "message": "Validation errors"
}
Response examples (401) 
{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}
Response examples (404) 
{
  "status": "Failure",
  "messages": [
    "User not found for specified username."
  ]
}