Create Permission

Create a permission with a POST request to the endpoint.

Before granting a permission, the user must first be added as a member of the organization.
If you need to add a SmartBox user to your organization, refer to the Organization Membership API. For details on different user types, please see the Help Center.

Request Structure

The POST body must include the necessary data to create the permission, formatted as a JSON object.

{
    "user": {
        "id": 123456
    },
    "key": {
        "id": 654321
    },
    "role": "ADMINISTRATOR"
}
❗️

Only one of the following should be specified in the request body:

  • Group ID
  • Key ID
  • Location ID
    depending on the resource you are granting permission for.

Response

If the request is successful, the API returns the newly created Permission object.

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!