UnaConnect RESTFUL API

Scroll down for code samples, example requests and responses.

POST
Create a Role
Body parameter
{
  "name": "string",
  "description": "string",
  "permissions": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyRoleInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseRole
400Bad RequestBad requestNone

PUT
Update a Role
Body parameter
{
  "roleId": "string",
  "groupId": "string",
  "name": "string",
  "description": "string",
  "permissions": [
    "string"
  ]
}

Parameters

NameInTypeRequiredDescription
bodybodyUpdateRoleInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseRole
400Bad RequestBad requestNone

DELETE
Delete a Role

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe ID of a Group
roleIdquerystringtrueThe ID of the role
userIdquerystringtrueThe ID of a User

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseRole
400Bad RequestBad requestNone

Schemas

Role

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

NameTypeRequiredRestrictionsDescription
idstringtruenonenone
namestringtruenonenone
descriptionstringtruenonenone
permissions[string]truenonenone
removablebooleanfalsenonenone

RoleConnection

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

NameTypeRequiredRestrictionsDescription
items[Role]falsenonenone

RoleInput

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

NameTypeRequiredRestrictionsDescription
namestringtruenonenone
descriptionstringtruenonenone
permissionsstringtruenonenone

UpdateRoleInput

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

NameTypeRequiredRestrictionsDescription
roleIdstringtruenonenone
groupIdstringtruenonenone
namestringfalsenonenone
descriptionstringfalsenonenone
permissions[string]falsenonenone

DeleteRoleInput

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

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
roleIdstringtruenonenone
userIdstringtruenonenone

UpdateUserRoleGroupInput

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

NameTypeRequiredRestrictionsDescription
userIdstringtruenonenone
groupIdstringtruenonenone
roleIdstringtruenonenone