Reference Turnkey Applications Tutorials Visual Designer
Reference Turnkey Applications Tutorials Visual Designer
    • REST API
      • Overview
      • API Endpoint
      • Authentication
      • Requests
      • Responses
      • Paging
      • Reason Codes Dictionary
    • Management APIs
      • Accounts
      • Identity Access Management BETA
        • Identity Access Management Overview
        • Identity Access Management API
          • User Management
            • Create a User
            • Update a User
            • Retrieve a User
            • Delete a User
          • API Keys Management
            • Create an API Key
            • Update an API Key
            • Retrieve an API Key
            • Delete an API Key
      • Applications
      • Clients
        • Create a Client
        • Delete a Client
        • Change Client’s Password
        • Get a List of Available Clients
      • Incoming Phone Numbers
        • IncomingPhoneNumber Instance Resource
        • IncomingPhoneNumbers List Resource
        • Local IncomingPhoneNumber Factory Resource
        • Toll-Free IncomingPhoneNumber Factory Resource
        • Mobile IncomingPhoneNumber Factory Resource
        • Attach a phone number to an application
        • Enable Incoming MMS for an Application
        • Delete a phone number
        • List of Phone Numbers
        • Incoming Phone Number Regex Support
      • Notifications
      • Usage Records
      • Trace Records
    • Voice
      • Calls
        • Call List Resource URI
        • Making a Call
        • Modifying Live Calls
        • Examples
        • List Filter
        • Paging Information
      • Conference Management
        • Supported Operations
        • Conference List Resource URI
      • Conference Participants Management
        • Participants List Resource URI
      • Gather DTMF
      • Gather Speech
      • Say
      • Play
      • Hold
      • Recordings
      • Refers
        • Resource Properties
        • Supported Operations
        • Paging Information
      • Resume
      • SIP Refer Support
    • Messages API - BETA
      • Overview
      • Channel Identities
      • Send Message
      • Status Callback Parameters
      • Status Callback Events
      • Receive Message
        • Incoming Message Request Parameters
      • Get Message List
      • Get Single Message
      • Message Attributes
      • Status Description
    • SMS
      • Messages
        • Send SMS
        • Get SMS List
        • Get single SMS Information
        • SMS Attributes
      • Error Codes
    • Email
    • RCML
      • Overview
        • Interacting with Your Application
        • RCML Verbs
      • Dial
        • Client
        • Conference
        • Number
        • SIP
      • Email
      • Gather
      • Say
      • Play
      • SMS
      • Message - Beta
      • Hold
      • Resume
      • Hangup
      • Pause
      • Redirect
      • Record
      • Reject
      • Refer
    • Visual Designer API
      • List Application Templates
      • :List a Specific Application Template
      • Create a Visual Designer Application
      • Get Application Details
      • Save Application Changes
      • Create Application Parameters
      • List Application Parameters
      • Delete Application Parameters
      • Upload Application Media Files
      • List Application Media Files
      • Play Application Media Files
      • Delete Application Media Files
      • Get Application Logs
      • Delete Application Logs
      • Get Application Settings
      • Modify Application Settings
      • Rename an Application
      • Delete an Application
      • Get Visual Designer Configuration
    • Turnkey Apps APIs
      • Smart 2FA
        • Sending One-Time Passwords
        • Verifying One-Time Passwords
        • Cancel One-Time Passwords
        • Session Detail Record (SDR)
        • Get list of One-Time Passwords
        • Get a Single One-Time Password
        • Usage Record One-Time Passwords
        • Common Response Error Code
        • Limit
          • Create Limit
          • Update Limit
          • Delete Limit
          • Get List of Limits
      • Call Queuing
      • Auto Attendant
        • Users
        • Announcement
        • Auto Attendant System
        • Menu
        • Schedule
        • Phone Number
        • Usage Records
        • Third Party Integration
      • Number Masking
        • Application
        • Mask Number Pool
        • Context
        • Participants
        • Interactions
        • Usage Records
      • Task Router
docs 1.0
  • docs
    • 1.0
  • docs
  • Enterprise:Management APIs
  • Enterprise:Identity Access Management BETA

Identity Access Management Overview

Overview

Identity Access Management allows you to create and manage users with specific roles and permissions to manage access to their CPaaS account’s resources.

You can create users with different roles under your Account.

To access assigned resources via the available CPaaS APIs, each user can create API Access Keys. Those are long-term credentials for an IAM user. Access keys consist of two parts: an access key ID and a secret access key.

Accounts and Users that have been migrated from the legacy to the new Identity Access Management functionality do not have to perform this step. Their API keys are automatically generated during the migration process.

Like a username and password, users must use both the Access Key ID and the Secret Access Key together to authenticate API requests. Manage Access Keys as securely as would be done for username and password.

When users create an Access Key pair, they need to save the access key ID and secret access key in a secure location. The secret access key is available only once, at the time of creation. If a secret access key is lost, it must be deleted and a new one should be created.

Users can create, modify and delete their access keys and have a maximum of two access keys at any given time. This allows users to rotate the active keys according to security best practices.

Your Account

When your Account is created, an Administrator User will be generated. Through this User, you can create more Users and enable or disable access to Platform or Turnkey Application resources.

User Roles

Your users can have any of the roles below:

  • Administrator

  • Developer

  • Turnkey Applications Administrator

  • Turnkey Applications Developer

IAM User Roles and Permissions

User Permissions

The user permissions represent the level of user access to various Platform and Turnkey Applications resources.

Understanding the User Roles and Permissions

The table below specifies the various User roles and their corresponding permissions.

Capability Availability at that Account Hierarchy Level

Administrator

Developer

Turnkey Applications Administrator

Turnkey Applications Developer

Platform Resources

Account Settings

Yes

read only

read only

no access

no access

API Credentials

Yes

read/write

read/write

no access

no access

Audit API

No

no access

no access

no access

no access

Feature Access Control Management

No

no access

no access

no access

no access

User Management

Yes

read/write

no access

read/write

no access

Role Access

Yes

- Business Customer Administrator
- Business Customer Developer
- Business Customer Turnkey Applications Administrator
- Business Customer Turnkey Applications Developer

no access

- Business Customer Turnkey Applications Administrator
- Business Customer Turnkey Applications Developer

no access

Whitelabeling Settings

No

no access

no access

no access

no access

BYOC Settings

No

no access

no access

no access

no access

Manage Enterprise Accounts

No

no access

no access

no access

no access

Communications Partner Organization/Account Management

No

no access

no access

no access

no access

Turnkey Applications Enablement Management

No

no access

no access

no access

no access

Manage Applications

Yes

read/write

read/write

no access

no access

Manage Numbers

Yes

read/write

read/write

no access

no access

Manage SIP/WebRTC Clients

Yes

read/write

read/write

no access

no access

P. SMS

Yes

read/write

read/write

no access

no access

P. Voice

Yes

read/write

read/write

no access

no access

Call Logs

Yes

read only

read only

no access

no access

SMS Logs

Yes

read only

read only

no access

no access

SMS Logs Content

Yes

read only

read only

no access

no access

Recordings

Yes

read/write

read/write

no access

no access

Recordings Content

Yes

read only

read only

no access

no access

Usage

Yes

read only

read only

no access

no access

Notifications

Yes

read only

read only

no access

no access

OutgoingCallerIDs

No

no access

no access

no access

no access

Visual Designer

Yes

read/write

read/write

no access

no access

Turnkey Applications

Auto Attendant

AA-Provisioning (GET, POST, PUT, DELETE)
AA-Announcement (CSP_ADMIN or SUPER_ADMIN or BG_ADMIN or AA_ADMIN)
AA-Menu
AA-Schedule

read/write

no access

no access

read/write

read/write

AA-System(CSP_ADMIN or SUPER_ADMIN) AA-Phone Number AA-Single Sign On

read only

no access

no access

read only

read only

AA- Usage Records

read only

no access

no access

read only

read only

AA-Enterprise And User

read only

no access

no access

read only

read only

AA-Search and Usage record all endpoints all levels

no access

no access

no access

no access

no access

Number Masking

NM-Provisioning(GET, POST, PUT, DELETE)
NM-User (CSP_ADMIN or SUPER_ADMIN or ENTERPRISE_ADMIN)
NM-Application
NM-Context
NM-Interaction
NM-Masked Number
NM-Participant
NM-Phone Number

read/write

no access

no access

read/write

no access

NM-Usage records

read only

no access

no access

read only

no access

NM-Enterprise And User

read only

no access

no access

read only

no access

NM- Search and Usage record all endpoints all levels

no access

no access

no access

no access

no access

Task Router

TR-Provisioning (GET, POST, PUT, DELETE)
TR-Workspace
TR-WorkFlow
TR-TaskQueue
TR-Activity
TR-Worker
TR-Reservation
TR-Task

read/write

no access

no access

read/write

no access

TR-Usage Records

read only

no access

no access

read only

no access

TR-Enterprise And User

no access

no access

no access

no access

no access

TR- Search and Usage record all endpoints all levels

no access

no access

no access

no access

no access

Smart 2FA

2FA-Traffic
send/verify/cancel

read/write

no access

no access

read/write

no access

2FA-Limit Provision
2FA-WorkFlow provision

read/write

no access

no access

read/write

no access

2FA-Usage Records

read only

no access

no access

read only

no access

2FA-Search and Usage record all endpoints all levels

no access

no access

no access

no access

no access

Campaign Manager

Campaign Manager-Provisioning (GET, POST, PUT, DELETE)
Enterprise
Users
Enterprise Credit

no access

no access

no access

no access

no access

Campaigns (GET, POST, PUT, DELETE)

read/write

no access

no access

read/write

no access

Usage records

read only

no access

no access

read only

no access

Search and Usage Records
All endpoints all levels

no access

no access

no access

no access

no access

API Definition

Getting Started with the Identity Access Management API

Platform

Programmable Voice

Programmable SMS

Turnkey Applications

Smart 2FA

Call Queue

Auto Attendant

Number Masking

Task Router

Campaign Manager

Learn

Terms And Conditions

About

ABOUT

CONTACT US

© 2020, All rights reserved.