Read One Gateway
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Bearer {{accessToken}}")
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))
}
GET /environments/{{envID}}/gateways/{{gatewayID}} HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}")
.method("GET", body)
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}",
"method": "GET",
"timeout": 0,
"headers": {
"Authorization": "Bearer {{accessToken}}"
},
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'GET',
'url': '{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}',
'headers': {
'Authorization': 'Bearer {{accessToken}}'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}"
payload = {}
headers = {
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Authorization' => 'Bearer {{accessToken}}'
));
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"
url = URI("{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"
response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "GET"
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/5cf92ccb-0186-41f3-9d81-xxxxxxxxxxxx/gateways/d2874a98-26df-490c-844a-c345f35594a1"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/5cf92ccb-0186-41f3-9d81-xxxxxxxxxxxx"
},
"instances": {
"href": "https://api.pingone.com/v1/environments/5cf92ccb-0186-41f3-9d81-xxxxxxxxxxxx/gateways/d2874a98-26df-490c-844a-c345f35594a1/instances"
},
"credentials": {
"href": "https://api.pingone.com/v1/environments/5cf92ccb-0186-41f3-9d81-xxxxxxxxxxxx/gateways/d2874a98-26df-490c-844a-c345f35594a1/credentials"
}
},
"id": "d2874a98-26df-490c-844a-xxxxxxxxxxxx",
"environment": {
"id": "5cf92ccb-0186-41f3-9d81-xxxxxxxxxxxx"
},
"name": "LDAP-Gateway-MyTest",
"description": "My LDAP gateway",
"type": "LDAP",
"enabled": false,
"supportedVersions": [
{
"version": "3.0.4",
"image": "pingidentity/pingone-ldap-gateway:3.0.4",
"recommended": true,
"latest": true
},
{
"version": "3.0.1",
"image": "pingidentity/pingone-ldap-gateway:3.0.1",
"supportEndsOn": "2024-12-31T00:00:00.000Z",
"daysUntilSupportEnds": 248
},
{
"version": "2.3.4",
"image": "pingidentity/pingone-ldap-gateway:2.3.4",
"supportEndsOn": "2024-11-30T00:00:00.000Z",
"daysUntilSupportEnds": 217
},
{
"version": "2.3.4",
"image": "gcr.io/ping-identity/pingone/pingone-ldap-gateway:2.3.4",
"supportEndsOn": "2024-11-30T00:00:00.000Z",
"daysUntilSupportEnds": 217
}
],
"currentAlerts": [
{
"category": "No Instances Connected",
"detail": "No gateway instances are connected. All operations that require access to this gateway will fail.",
"severity": "ERROR"
}
],
"bindDN": "cn=svc-account",
"connectionSecurity": "None",
"vendor": "PingDirectory",
"followReferrals": false,
"userTypes": [
{
"id": "07b24f61-9031-44d1-88bc-e7279d7fd754",
"name": "myType",
"passwordAuthority": "LDAP",
"searchBaseDn": "dc=example,dc=com",
"orderedCorrelationAttributes": [
"externalid",
"uid",
"username"
],
"newUserLookup": {
"ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
"population": {
"id": "f5d70107-ee11-481c-a73d-f3d812808d76"
},
"attributeMappings": [
{
"name": "username",
"value": "${ldapAttributes.uid}"
}
]
},
"allowPasswordChanges": true,
"updateUserOnSuccessfulAuthentication": true
}
],
"validateTlsCertificates": true,
"serversHostAndPort": [
"host1:389",
"host.domain.com:389",
"10.10.10.10:333",
"2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
]
}