Basic Authentication Connections

Stores and manages basic authentication credentials for an integration. See Understanding connections.

JSON format

Basic Authentication Connections are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
allowed_domain	string	false	true	Hostname the connection can be used on. See Allowed domain
created_at	string	true	false	When the connection was created
name	string	false	true	Name used to uniquely identify the connection. See Connection names
password	string	false	true	The password of the basic authentication credentials. For security purposes, this value is redacted in responses
updated_at	string	true	false	When the connection was last updated
username	string	false	true	The username of the basic authentication credentials

Create Basic Authentication Connection

• POST /api/services/zis/integrations/{integration}/connections/basic_auth

Creates a basic authentication connection for the integration.

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Parameters

Name	Type	In	Required	Description
integration	string	Path	true	Name of the integration

Example body

{
  "allowed_domain": "api.example.com",
  "name": "my_basic_auth_connection",
  "password": "MY_PASSWORD",
  "username": "[email protected]"
}

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/basic_auth \
-H "Authorization: Bearer {access_token}" \
-X POST \
-H 'content-type: application/json' \
-d '{
  "name": "my_basic_auth_connection",
  "username": "[email protected]",
  "password": "MY_PASSWORD",
  "allowed_domain": "api.example.com"
  }'

Example response(s)

201 Created

Status 201 Created

{
  "basic_auth": {
    "allowed_domain": "api.example.com",
    "created_at": "1985-04-12T23:20:50.52Z",
    "name": "my_basic_auth_connection",
    "password": "*****",
    "updated_at": "1985-04-12T23:20:50.52Z",
    "username": "[email protected]"
  }
}

400 Bad Request

Status 400 Bad Request

{
  "errors": [
    {
      "code": "InvalidIntegration",
      "title": "Specified integration is not valid"
    }
  ]
}

401 Unauthorized

Status 401 Unauthorized

{
  "errors": [
    {
      "code": "InvalidCredentials",
      "title": "Token length is invalid"
    }
  ]
}

403 Forbidden

Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "title": "Cannot access this resource. Missing scope write"
    }
  ]
}

409 Conflict

Status 409 Conflict

{
  "errors": [
    {
      "code": "Conflict",
      "title": "Resource conflict"
    }
  ]
}

429 Too Many Requests

Status 429 Too Many Requests

{
  "errors": [
    {
      "code": "TooManyRequests",
      "title": "Too many requests"
    }
  ]
}

Show Basic Authentication Connection

• GET /api/services/zis/integrations/{integration}/connections/basic_auth/{name}

Returns the details of a basic authentication connection.

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Parameters

Name	Type	In	Required	Description
integration	string	Path	true	Name of the integration
name	string	Path	true	Name of the basic authentication connection

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/basic_auth/{name} \
-H "Authorization: Bearer {access_token}"

Example response(s)

200 OK

Status 200 OK

{
  "basic_auth": {
    "allowed_domain": "api.example.com",
    "created_at": "1985-04-12T23:20:50.52Z",
    "name": "my_basic_auth_connection",
    "password": "*****",
    "updated_at": "1985-04-12T23:20:50.52Z",
    "username": "[email protected]"
  }
}

401 Unauthorized

Status 401 Unauthorized

{
  "errors": [
    {
      "code": "InvalidCredentials",
      "title": "Token length is invalid"
    }
  ]
}

403 Forbidden

Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "title": "Cannot access this resource. Missing scope write"
    }
  ]
}

404 Not Found

Status 404 Not Found

{
  "errors": [
    {
      "code": "NotFound",
      "title": "Connection does not exist"
    }
  ]
}

429 Too Many Requests

Status 429 Too Many Requests

{
  "errors": [
    {
      "code": "TooManyRequests",
      "title": "Too many requests"
    }
  ]
}

Update Basic Authentication Connection

• PATCH /api/services/zis/integrations/{integration}/connections/basic_auth/{name}

Updates details of a basic authentication connection

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Parameters

Name	Type	In	Required	Description
integration	string	Path	true	Name of the integration
name	string	Path	true	Name of the basic authentication connection

Example body

{
  "password": "MY_PASSWORD",
  "username": "[email protected]"
}

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/basic_auth/{name} \
-H "Authorization: Bearer {access_token}" \
-X PATCH \
-H 'content-type: application/json' \
-d '{
  "username": "[email protected]",
  "password": "MY_PASSWORD"
  }'

Example response(s)

204 No Content

Status 204 No Content

400 Bad Request

Status 400 Bad Request

{
  "errors": [
    {
      "code": "InvalidIntegration",
      "title": "Specified integration is not valid"
    }
  ]
}

401 Unauthorized

Status 401 Unauthorized

{
  "errors": [
    {
      "code": "InvalidCredentials",
      "title": "Token length is invalid"
    }
  ]
}

403 Forbidden

Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "title": "Cannot access this resource. Missing scope write"
    }
  ]
}

404 Not Found

Status 404 Not Found

{
  "errors": [
    {
      "code": "NotFound",
      "title": "Connection does not exist"
    }
  ]
}

429 Too Many Requests

Status 429 Too Many Requests

{
  "errors": [
    {
      "code": "TooManyRequests",
      "title": "Too many requests"
    }
  ]
}

Delete Basic Authentication Connection

• DELETE /api/services/zis/integrations/{integration}/connections/basic_auth/{name}

Deletes a basic authentication connection.

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Parameters

Name	Type	In	Required	Description
integration	string	Path	true	Name of the integration
name	string	Path	true	Name of the basic authentication connection

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/basic_auth/{name} \
-H "Authorization: Bearer {access_token}" \
-X DELETE

Example response(s)

204 No Content

Status 204 No Content

401 Unauthorized

Status 401 Unauthorized

{
  "errors": [
    {
      "code": "InvalidCredentials",
      "title": "Token length is invalid"
    }
  ]
}

403 Forbidden

Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "title": "Cannot access this resource. Missing scope write"
    }
  ]
}

404 Not Found

Status 404 Not Found

{
  "errors": [
    {
      "code": "NotFound",
      "title": "Connection does not exist"
    }
  ]
}

429 Too Many Requests

Status 429 Too Many Requests

{
  "errors": [
    {
      "code": "TooManyRequests",
      "title": "Too many requests"
    }
  ]
}