SIP Credential Resource
The Credential resource stores usernames and password information.
Username and Password
Each Username
requires a corresponding password that meets the requirements in the Password
parameter's description.
We don't store the passwords you provide in the credential records as cleartext. Instead, they are MD5 hashed in accordance with the digest authentication specification.
SIP Credential properties
Resource Properties in REST API format | |
---|---|
sid
|
A 34 character string that uniquely identifies this resource. |
account_sid
|
The unique id of the Account that is responsible for this resource. |
credential_list_sid
|
The unique id that identifies the credential list that includes this credential. |
username
|
The username for this credential. |
date_created
|
The date that this resource was created, given as GMT in RFC 2822 format. |
date_updated
|
The date that this resource was last updated, given as GMT in RFC 2822 format. |
uri
|
The URI for this resource, relative to |
Create a SIP Credential resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The unique id of the Account that is responsible for this resource. |
credential_list_sid
Path
|
The unique id that identifies the credential list to include the created credential. |
username
Required
|
The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long. |
password
Required
|
The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg |
Example 1
Fetch a SIP Credential resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The unique id of the Account that is responsible for this resource. |
credential_list_sid
Path
|
The unique id that identifies the credential list that contains the desired credential. |
sid
Path
|
The unique id that identifies the resource to fetch. |
Example 1
Read multiple SIP Credential resources
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The unique id of the Account that is responsible for this resource. |
credential_list_sid
Path
|
The unique id that identifies the credential list that contains the desired credentials. |
Example 1
Update a SIP Credential resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json
The update action is used to update a user's password.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The unique id of the Account that is responsible for this resource. |
credential_list_sid
Path
|
The unique id that identifies the credential list that includes this credential. |
sid
Path
|
The unique id that identifies the resource to update. |
password
Optional
|
The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg |
Example 1
Delete a SIP Credential resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The unique id of the Account that is responsible for this resource. |
credential_list_sid
Path
|
The unique id that identifies the credential list that contains the desired credentials. |
sid
Path
|
The unique id that identifies the resource to delete. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.