Role

Create a Role

Update a Role

Delete a Role

Create a Role

POST /role

Create a Role

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Body parameter

{
  "name": "string",
  "description": "string",
  "permissions": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	RoleInput	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success response	Role
400	Bad Request	Bad request	None

Update a Role

PUT /role

Update a Role

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Body parameter

{
  "roleId": "string",
  "groupId": "string",
  "name": "string",
  "description": "string",
  "permissions": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateRoleInput	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success response	Role
400	Bad Request	Bad request	None

Delete a Role

DELETE /role

Delete a Role

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

Name	In	Type	Required	Description
groupId	query	string	true	The ID of a Group
roleId	query	string	true	The ID of the role
userId	query	string	true	The ID of a User

Responses

Status	Meaning	Description	Schema
200	OK	Success response	Role
400	Bad Request	Bad request	None

Schemas

Role

{
  "id": "string",
  "name": "string",
  "description": "string",
  "permissions": [
    "string"
  ],
  "removable": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
description	string	true	none	none
permissions	[string]	true	none	none
removable	boolean	false	none	none

RoleConnection

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "permissions": [
        "string"
      ],
      "removable": true
    }
  ],
  "nextToken": "string"
}

Properties

Name	Type	Required	Restrictions	Description
items	[Role]	false	none	none

RoleInput

{
  "name": "string",
  "description": "string",
  "permissions": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
permissions	string	true	none	none

UpdateRoleInput

{
  "roleId": "string",
  "groupId": "string",
  "name": "string",
  "description": "string",
  "permissions": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
roleId	string	true	none	none
groupId	string	true	none	none
name	string	false	none	none
description	string	false	none	none
permissions	[string]	false	none	none

DeleteRoleInput

{
  "groupId": "string",
  "roleId": "string",
  "userId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
groupId	string	true	none	none
roleId	string	true	none	none
userId	string	true	none	none

UpdateUserRoleGroupInput

{
  "userId": "string",
  "groupId": "string",
  "roleId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userId	string	true	none	none
groupId	string	true	none	none
roleId	string	true	none	none