Permission

GET /permission
Get the list of all UnaConnect user permissions
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

Responses

StatusMeaningDescriptionSchema
200OKThe list of user permissionsPermissionConnection
400Bad RequestBad requestNone

POST /permission
Create a permission
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "permissionId": "string",
  "name": "string",
  "description": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyPermissionInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responsePermission
400Bad RequestBad requestNone

PUT /permission
Update a permission
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "permissionId": "string",
  "name": "string",
  "description": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyPermissionInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responsePermission
400Bad RequestBad requestNone

DELETE /permission
Delete a permission
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
permissionIdquerystringtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responsePermission
400Bad RequestBad requestNone

Schemas

Permission

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

NameTypeRequiredRestrictionsDescription
idstringtruenonenone
namestringtruenonenone
descriptionstringtruenonenone

PermissionConnection

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

NameTypeRequiredRestrictionsDescription
items[Permission]falsenonenone

PermissionInput

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

NameTypeRequiredRestrictionsDescription
permissionIdstringtruenonenone
namestringtruenonenone
descriptionstringtruenonenone