Update an existing role

PATCH 
/roles/:id

Update an existing role

Request

Path Parameters

id uuidrequired

ID of the object to retrieve, update, or delete

application/json

Body

required

role object

type string

Possible values: [NeprofileRole, NeaccessRole]

The type of role

name string

The name of the user role

archived boolean

Set to true to archive, false to unarchive

groups string[]

Role groups

Responses

200

Expected response to a valid request

application/json

Schema

Schema

role object
id uuid
uid string
Possible values: >= 32 characters and <= 32 characters
name string
groups string[]

Example (from schema)

{
  "role": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "uid": "sponsors_role",
    "name": "Sponsors",
    "groups": [
      "ad_group_name"
    ]
  }
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf
InvalidJson
error
ValidationErrors
error
errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "Sorry something went wrong"
}

Loading...