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]"
}
Code Samples
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"
}'
Go
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
url := "https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth"
method := "POST"
payload := strings.NewReader(`{
"allowed_domain": "api.example.com",
"name": "my_basic_auth_connection",
"password": "MY_PASSWORD",
"username": "[email protected]"
}`)
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
client := &http.Client {}
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Java
import com.squareup.okhttp.*;
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth")
.newBuilder();
RequestBody body = RequestBody.create(MediaType.parse("application/json"),
"""
{
\"allowed_domain\": \"api.example.com\",
\"name\": \"my_basic_auth_connection\",
\"password\": \"MY_PASSWORD\",
\"username\": \"john.doe@example.com\"
}""");
Request request = new Request.Builder()
.url(urlBuilder.build())
.method("POST", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
Nodejs
var axios = require('axios');
var data = JSON.stringify({
"allowed_domain": "api.example.com",
"name": "my_basic_auth_connection",
"password": "MY_PASSWORD",
"username": "[email protected]"
});
var config = {
method: 'POST',
url: 'https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth',
headers: {
'Content-Type': 'application/json',
},
data : data,
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Python
import requests
import json
url = "https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth"
payload = json.loads("""{
"allowed_domain": "api.example.com",
"name": "my_basic_auth_connection",
"password": "MY_PASSWORD",
"username": "[email protected]"
}""")
headers = {
"Content-Type": "application/json",
}
response = requests.request(
"POST",
url,
headers=headers,
json=payload
)
print(response.text)
Ruby
require "net/http"
uri = URI("https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth")
request = Net::HTTP::Post.new(uri, "Content-Type": "application/json")
request.body = %q({
"allowed_domain": "api.example.com",
"name": "my_basic_auth_connection",
"password": "MY_PASSWORD",
"username": "[email protected]"
})
response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
http.request(request)
end
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 |
Code Samples
cURL
curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/basic_auth/{name} \
-H "Authorization: Bearer {access_token}"
Go
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection"
method := "GET"
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
client := &http.Client {}
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Java
import com.squareup.okhttp.*;
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection")
.newBuilder();
Request request = new Request.Builder()
.url(urlBuilder.build())
.method("GET", null)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
Nodejs
var axios = require('axios');
var config = {
method: 'GET',
url: 'https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection',
headers: {
'Content-Type': 'application/json',
},
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Python
import requests
url = "https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection"
headers = {
"Content-Type": "application/json",
}
response = requests.request(
"GET",
url,
headers=headers
)
print(response.text)
Ruby
require "net/http"
uri = URI("https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection")
request = Net::HTTP::Get.new(uri, "Content-Type": "application/json")
response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
http.request(request)
end
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]"
}
Code Samples
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"
}'
Go
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
url := "https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection"
method := "PATCH"
payload := strings.NewReader(`{
"password": "MY_PASSWORD",
"username": "[email protected]"
}`)
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
client := &http.Client {}
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Java
import com.squareup.okhttp.*;
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection")
.newBuilder();
RequestBody body = RequestBody.create(MediaType.parse("application/json"),
"""
{
\"password\": \"MY_PASSWORD\",
\"username\": \"john.doe@example.com\"
}""");
Request request = new Request.Builder()
.url(urlBuilder.build())
.method("PATCH", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
Nodejs
var axios = require('axios');
var data = JSON.stringify({
"password": "MY_PASSWORD",
"username": "[email protected]"
});
var config = {
method: 'PATCH',
url: 'https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection',
headers: {
'Content-Type': 'application/json',
},
data : data,
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Python
import requests
import json
url = "https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection"
payload = json.loads("""{
"password": "MY_PASSWORD",
"username": "[email protected]"
}""")
headers = {
"Content-Type": "application/json",
}
response = requests.request(
"PATCH",
url,
headers=headers,
json=payload
)
print(response.text)
Ruby
require "net/http"
uri = URI("https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection")
request = Net::HTTP::Patch.new(uri, "Content-Type": "application/json")
request.body = %q({
"password": "MY_PASSWORD",
"username": "[email protected]"
})
response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
http.request(request)
end
Example response(s)
204 No Content
// Status 204 No Content
null
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 |
Code Samples
cURL
curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/basic_auth/{name} \
-H "Authorization: Bearer {access_token}" \
-X DELETE
Go
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection"
method := "DELETE"
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
client := &http.Client {}
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Java
import com.squareup.okhttp.*;
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection")
.newBuilder();
Request request = new Request.Builder()
.url(urlBuilder.build())
.method("DELETE", null)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
Nodejs
var axios = require('axios');
var config = {
method: 'DELETE',
url: 'https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection',
headers: {
'Content-Type': 'application/json',
},
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Python
import requests
url = "https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection"
headers = {
"Content-Type": "application/json",
}
response = requests.request(
"DELETE",
url,
headers=headers
)
print(response.text)
Ruby
require "net/http"
uri = URI("https://support.zendesk.com/api/services/zis/integrations/my_integration/connections/basic_auth/my_basic_auth_connection")
request = Net::HTTP::Delete.new(uri, "Content-Type": "application/json")
response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
http.request(request)
end
Example response(s)
204 No Content
// Status 204 No Content
null
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"
}
]
}