Roles

List roles

List a collection of roles.

get

/roles

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/roles' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "count": 100,
  "items": [
    {
      "name": "User",
      "description": "text"
    }
  ]
}

OK

Create a role

Create a new role.

post

/roles

Authorizations

Body

namestring · min: 1 · max: 64required

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: User

descriptionstring · max: 1024

Role's description.

permissionsobjectrequired

The permission list of role.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/roles' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "User",
    "description": "text",
    "permissions": {
      "general": {
        "voicemail_view_only": false,
        "voicemail_full_access": false,
        "meeting": false
      },
      "system": {
        "information": false,
        "dealer": false,
        "tenant": false
      },
      "trunk": {
        "view_only": false,
        "full_access": false
      },
      "company": {
        "view_only": false,
        "full_access": false
      },
      "company_call_log": {
        "call_log_view_only": false,
        "call_log_full_access": false,
        "call_recording_view_only": false,
        "call_recording_full_access": false
      },
      "phone_system": {
        "view_only": false,
        "full_access": false
      },
      "user_management": {
        "roles": false,
        "users": false
      },
      "user_call_log": {
        "call_log_view_only": false,
        "call_log_full_access": false,
        "call_recording_view_only": false,
        "call_recording_full_access": false
      },
      "policies": {
        "domestic_calls": false,
        "internal_calls": false,
        "international_calls": false
      },
      "analytics": {
        "call_report_view_only": false,
        "call_report_full_access": false
      },
      "billing": {
        "view_only": false,
        "full_access": false
      }
    }
  }'

201

4XX

201

{
  "name": "User"
}

OK

Retrieve a role

Retrieves the settings of a role.

get

/roles/{name}

Authorizations

Path parameters

namestring · min: 1 · max: 64required

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: User

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/roles/{name}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "name": "User",
  "description": "text",
  "permissions": {
    "general": {
      "voicemail_view_only": false,
      "voicemail_full_access": false,
      "meeting": false
    },
    "system": {
      "information": false,
      "dealer": false,
      "tenant": false
    },
    "trunk": {
      "view_only": false,
      "full_access": false
    },
    "company": {
      "view_only": false,
      "full_access": false
    },
    "company_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "phone_system": {
      "view_only": false,
      "full_access": false
    },
    "user_management": {
      "roles": false,
      "users": false
    },
    "user_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "policies": {
      "domestic_calls": false,
      "internal_calls": false,
      "international_calls": false
    },
    "analytics": {
      "call_report_view_only": false,
      "call_report_full_access": false
    },
    "billing": {
      "view_only": false,
      "full_access": false
    }
  }
}

OK

Update a role

Modify the settings of a role.

post

/roles/{name}

Authorizations

Path parameters

namestring · min: 1 · max: 64required

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: User

Body

namestring · min: 1 · max: 64

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: User

descriptionstring · max: 1024

Role's description.

permissionsobject

The permission list of role.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/roles/{name}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "User",
    "description": "text",
    "permissions": {
      "general": {
        "voicemail_view_only": false,
        "voicemail_full_access": false,
        "meeting": false
      },
      "system": {
        "information": false,
        "dealer": false,
        "tenant": false
      },
      "trunk": {
        "view_only": false,
        "full_access": false
      },
      "company": {
        "view_only": false,
        "full_access": false
      },
      "company_call_log": {
        "call_log_view_only": false,
        "call_log_full_access": false,
        "call_recording_view_only": false,
        "call_recording_full_access": false
      },
      "phone_system": {
        "view_only": false,
        "full_access": false
      },
      "user_management": {
        "roles": false,
        "users": false
      },
      "user_call_log": {
        "call_log_view_only": false,
        "call_log_full_access": false,
        "call_recording_view_only": false,
        "call_recording_full_access": false
      },
      "policies": {
        "domestic_calls": false,
        "internal_calls": false,
        "international_calls": false
      },
      "analytics": {
        "call_report_view_only": false,
        "call_report_full_access": false
      },
      "billing": {
        "view_only": false,
        "full_access": false
      }
    }
  }'

200

4XX

200

No body

OK