Skip to content

Permissions

GET/api/v1/Owners/{ownerAccountId}/Permissions

PUT/api/v1/Owners/{ownerAccountId}/Permissions

GET/api/v1/Owners/{ownerAccountId}/Permissions/{id}

DELETE/api/v1/Owners/{ownerAccountId}/Permissions/{id}

Get List of Permissions

GET/api/v1/Owners/{ownerAccountId}/Permissions

Get a list of permissions for the current owner.

Scope

read:owneraccount:permissions

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.

Success Response

200 OK

[
  {
    "id": "1",
    "ownerAccountId": "1",
    "contactId": "1",
    "role": "Owner"
  },
  {
    "id": "2",
    "ownerAccountId": "1",
    "contactId": "2",
    "role": "Admin"
  },
  {
    "id": "3",
    "ownerAccountId": "1",
    "contactId": "3",
    "role": "Admin"
  }
]

Error Responses

HTTP Status Code Error Code Description
400 Generic Error
401 Unauthorized
403 Forbidden

Put Permission

PUT/api/v1/Owners/{ownerAccountId}/Permissions

Create a new permission.

Scope

write:owneraccount:permissions

Body

{
  "contactId": "4",
  "role": "Admin"
}

Success Response

200 OK

{
  "id": "4",
  "ownerAccountId": "1",
  "contactId": "4",
  "role": "Admin"
}

Error Responses

HTTP Status Code Error Code Description
400 Generic Error
401 Unauthorized
402 InsufficientAccountLevel Indicates that the current subscription does not have sufficient means to fulfil the operation
403 Forbidden
404 Owner account/Contact not found

Get Permission by ID

GET/api/v1/Owners/{ownerAccountId}/Permissions/{id}

Get a specific owner account permission.

Scope

read:owneraccount:permissions

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.
id string path The permission's ID.

Success Response

200 OK

{
  "id": "1",
  "ownerAccountId": "1",
  "contactId": "1",
  "role": "Owner"
}

Error Responses

HTTP Status Code Error Code Description
400 Generic Error
401 Unauthorized
403 Forbidden

Delete Permission

DELETE/api/v1/Owners/{ownerAccountId}/Permissions/{id}

Delete a specific owner account permission.

Scope

write:owneraccount:permissions

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.
id string path The permission's ID.

Success Response

204 No Content

Error Responses

HTTP Status Code Error Code Description
400 Generic Error
401 Unauthorized
403 Forbidden
404 Entry not found