Update a role

Updates a role by id.

put

Path parameters

idstringRequired

The role id.

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class is used when creating or updating a Role.

codestring · min: 1Required

The code of the Role.

Example: EXAMPLE

namestring · min: 1Required

The name of the Role.

Example: Example

descriptionstring | nullableOptional

The description of the Role.

Example: Description

tagsstring | nullableOptional

The tags of the Role.

Example: #Example

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required AuthKey header.

application/json

403

The user's access was denied.

application/json

404

The Role was not found in the system.

application/json

429

The user has exceeded the rate limit.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/roles/{id} HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "code": "EXAMPLE",
  "name": "Example",
  "description": "Description",
  "tags": "#Example"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "parentBrandId": null,
    "guid": "6711cf9d-d179-4dc6-b4ee-492fa74643e9",
    "code": "EXAMPLE",
    "name": "Example",
    "description": "Description",
    "tags": "#Example",
    "type": "Custom",
    "permissions": [
      "Resource.Action"
    ],
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}