Skip to main content

Set a connection to use credential authentication

POST 
/security/connections/:connection_id/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 stringrequired

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

Body

required

Credential details

    user_name stringrequired

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

    password stringrequired

    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

Schema

    success booleanrequired
    message stringrequired

    reasons

    object

    property name*

    string[]

  • Array [

    • string

  • ]

400: Bad Request

401: Unauthorized

404: Record Not Found

Request samples

curl -L 'https://api.telnyx.com/security/connections/:connection_id/credential_authentication' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "user_name": "string",
  "password": "string",
  "webhook_url": "string",
  "failover_url": "string"
}'

Response samples

{
  "success": true,
  "message": "string",
  "reasons": {}
}