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
Name | In | Type | Required | Description |
---|
body | body | RoleInput | true | none |
Responses
PUT
Update a Role
Body parameter
{
"roleId": "string",
"groupId": "string",
"name": "string",
"description": "string",
"permissions": [
"string"
]
}
Parameters
Responses
DELETE
Delete a Role
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
Schemas
Role
{
"id": "string",
"name": "string",
"description": "string",
"permissions": [
"string"
],
"removable": true
}
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"
}
Name | Type | Required | Restrictions | Description |
---|
items | [Role] | false | none | none |
{
"name": "string",
"description": "string",
"permissions": "string"
}
Name | Type | Required | Restrictions | Description |
---|
name | string | true | none | none |
description | string | true | none | none |
permissions | string | true | none | none |
{
"roleId": "string",
"groupId": "string",
"name": "string",
"description": "string",
"permissions": [
"string"
]
}
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 |
{
"groupId": "string",
"roleId": "string",
"userId": "string"
}
Name | Type | Required | Restrictions | Description |
---|
groupId | string | true | none | none |
roleId | string | true | none | none |
userId | string | true | none | none |
{
"userId": "string",
"groupId": "string",
"roleId": "string"
}
Name | Type | Required | Restrictions | Description |
---|
userId | string | true | none | none |
groupId | string | true | none | none |
roleId | string | true | none | none |