Update a role

Update a role by id.

put

Path parameters

idstringRequired

The role id.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

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

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

404

The role was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

/api/v1/roles/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/roles/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "code": "DEVELOPER",
  "name": "Developer",
  "description": "Role for software developers with access to development tools and project resources.",
  "tags": "#it #system"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "parentBrandId": null,
    "guid": "27173619-c720-4f87-8a42-b80bd3fc5b24",
    "code": "EXAMPLE",
    "name": "Example",
    "description": "Description",
    "tags": "#Example",
    "type": "Custom",
    "permissions": [
      "Resource.Action"
    ]
  },
  "errors": []
}