Credential Authentication for Connections V1

Credential Authentication operations for connections

Set a connection to use credential authentication

Sets the authentication method of a connection and associates the credentials This will remove any other authentication type set for the connection.

Request
path Parameters
connection_id
required
string

ID of the connection which you will set to use this type of authentication

Request Body schema: application/json
required

Credential details

user_name
required
string

user_name that will be sent when using the connection. Must be globally unique. Case-insensitive.

password
required
string

password that will be sent when using the connection. Must be at least 8 characters or more in length.

webhook_url
string

URL to which Telnyx will deliver your Call Control webhooks

failover_url
string

URL to which Telnyx will deliver your Call Control webhooks if we get an error response from your webhook_url

Responses
200

Credential Authentication creation response

Response Schema: application/json
success
required
boolean
message
required
string
object
400

Bad Request

401

Unauthorized

404

Record Not Found

post/security/connections/{connection_id}/credential_authentication
Request samples
application/json
{
  • "user_name": "string",
  • "password": "string",
  • "webhook_url": "string",
  • "failover_url": "string"
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "reasons": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    }
}

Update credentials for a connection

Updates the connection credentials with the values of the parameters passed. Any parameters not included in the request will be left unchanged.

Request
path Parameters
connection_id
required
string

ID of the connection whose credentials are to be updated

Request Body schema: application/json
required

Credential details

user_name
required
string

user_name that will be sent when using the connection. Must be globally unique. Case-insensitive.

password
required
string

password that will be sent when using the connection. Must be at least 8 characters or more in length.

webhook_url
string

URL to which Telnyx will deliver your Call Control webhooks

failover_url
string

URL to which Telnyx will deliver your Call Control webhooks if we get an error response from your webhook_url

Responses
200

Credential Authentication update response

Response Schema: application/json
success
required
boolean
message
required
string
object
400

Bad Request

401

Unauthorized

404

Record Not Found

put/security/connections/{connection_id}/credential_authentication
Request samples
application/json
{
  • "user_name": "string",
  • "password": "string",
  • "webhook_url": "string",
  • "failover_url": "string"
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "reasons": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    }
}

Retrieve a credential suggestion

Retrieve suggestions for user_name and password to use when setting the credentials associated with a connection.

Request
path Parameters
connection_id
required
string

ID of the connection for which a user_name and password will be suggested

Responses
200

Credential Authentication suggestion response

Response Schema: application/json
user_name
required
string
password
required
string
400

Bad Request

401

Unauthorized

404

Record Not Found

get/security/connections/{connection_id}/credential_authentication/suggestion
Request samples 
Response samples 
application/json
{
  • "user_name": "string",
  • "password": "string"
}