Roles | PortSIP Knowledge Base

List roles

get

List a collection of roles.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

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

searchstringOptional

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

orderbystringOptional

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

skipinteger · int32Optional

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

Default: 0

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

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

Default: 100

Responses

200

OK

application/json

4XX

Error

get

/roles

GET /api/roles HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a role

post

Create a new role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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: 1024Optional

Role's description.

Responses

201

OK

application/json

4XX

Error

post

/roles

POST /api/roles HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 900

{
  "name": "User",
  "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
    }
  },
  "description": "text"
}

{
  "name": "User"
}

Retrieve a role

get

Retrieves the settings of a role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

200

OK

application/json

4XX

Error

get

/roles/{name}

GET /api/roles/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "User",
  "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
    }
  },
  "description": "text"
}

Update a role

post

Modify the settings of a role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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: 64Optional

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: 1024Optional

Role's description.

Responses

200

OK

No content

4XX

Error

post

/roles/{name}

POST /api/roles/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 900

{
  "name": "User",
  "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
    }
  },
  "description": "text"
}

No content