PingOne Platform APIs

Read One Authorize Gateway

GET {{apiPath}}/environments/{{envID}}/gateways/{{authorizeGatewayID}}

To get data for a single gateway resource, the GET {{apiPath}}/environments/{{envID}}/gateways/{{authorizeGatewayID}} operation returns data for the Authorize gateway resource with the specified ID.

To include gateway instances in the response, specify the expand query parameter using the value instances.

Query parameters
Query parameter Attributes (or allowed limits)

expand

instances

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/gateways/{{authorizeGatewayID}}' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/gateways/{{authorizeGatewayID}}")
{
  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/{{authorizeGatewayID}}"
  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/{{authorizeGatewayID}} 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/{{authorizeGatewayID}}")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/gateways/{{authorizeGatewayID}}",
  "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/{{authorizeGatewayID}}',
  '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/{{authorizeGatewayID}}"

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/{{authorizeGatewayID}}');
$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/{{authorizeGatewayID}}")

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/{{authorizeGatewayID}}")!,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/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/08d759a2-74ff-422d-9766-75c56ed2843a"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "instances": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/08d759a2-74ff-422d-9766-75c56ed2843a/instances"
        },
        "credentials": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/08d759a2-74ff-422d-9766-75c56ed2843a/credentials"
        },
        "populations": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations?filter=id+eq+%2289a7de36-c2ce-48d6-b453-9d7a7dd4dc3a%22"
        }
    },
    "id": "08d759a2-74ff-422d-9766-75c56ed2843a",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "LDAP Gateway2",
    "description": "LDAP gateway 2",
    "type": "LDAP",
    "enabled": true,
    "supportedVersions": [
        {
            "version": "4.0.3",
            "image": "pingidentity/pingone-ldap-gateway:4.0.3",
            "recommended": true,
            "latest": true
        },
        {
            "version": "4.0.2",
            "image": "pingidentity/pingone-ldap-gateway:4.0.2",
            "supportEndsOn": "2026-10-31T00:00:00.000Z",
            "daysUntilSupportEnds": 361
        },
        {
            "version": "3.4.0-HOTFIX1",
            "image": "pingidentity/pingone-ldap-gateway:3.4.0",
            "supportEndsOn": "2026-10-31T00:00:00.000Z",
            "daysUntilSupportEnds": 361
        },
        {
            "version": "3.4.0",
            "image": "pingidentity/pingone-ldap-gateway:3.4.0",
            "supportEndsOn": "2026-10-31T00:00:00.000Z",
            "daysUntilSupportEnds": 361
        },
        {
            "version": "3.3.0",
            "image": "pingidentity/pingone-ldap-gateway:3.3.0",
            "supportEndsOn": "2026-03-31T00:00:00.000Z",
            "daysUntilSupportEnds": 147
        }
    ],
    "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": "typeName",
            "passwordAuthority": "LDAP",
            "searchBaseDn": "dc=example,dc=com",
            "orderedCorrelationAttributes": [
                "externalid",
                "uid",
                "username"
            ],
            "newUserLookup": {
                "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
                "population": {
                    "id": "89a7de36-c2ce-48d6-b453-9d7a7dd4dc3a"
                },
                "attributeMappings": [
                    {
                        "name": "username",
                        "value": "${ldapAttributes.uid}"
                    }
                ]
            },
            "allowPasswordChanges": false,
            "updateUserOnSuccessfulAuthentication": false
        }
    ],
    "validateTlsCertificates": true,
    "serversHostAndPort": [
        "host1:389",
        "host.domain.com:389",
        "10.10.10.10:636",
        "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
    ]
}