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.

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"
  }
]

Put Permission¶

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

Create a new permission.

Scope¶

write:owneraccount:permissions

Body¶

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

Response¶

200 OK

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

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.

Response¶

200 OK

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

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.

Response¶

204 No Content