PingOne Platform APIs

Create Gateway Credentials

POST {{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials

The POST {{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials operation adds a new gateway credential to the gateway credentials list. The gateway credentials list supports a maximum of five credentials per gateway.

Prerequisites

  • Refer to Gateway Management for important overview information.

  • Use Read All Gateways to retrieve a list of all gateway IDs associated with the environment and select the specific gatewayID for the endpoint. For more information, refer to Gateways.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request POST '{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
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}}/credentials"
  method := "POST"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  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))
}
POST /environments/{{envID}}/gateways/{{gatewayID}}/credentials HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", 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}}/credentials');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  '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 "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}/credentials")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"

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

201 Created

{
    "id": "a10ed782-a6ff-4954-bb68-8d28b6fd3919",
    "createdAt": "2020-04-01T19:05:41.970Z",
    "credential": "eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJodHRwczpcL1wvbGlnaHRuaW5nLnBpbmdvbmUuY29tXC9MREFQXC84N2U3MzM0Mi1lN2U5LTQ3OWItYjZkMS0xODY3OTBjMDBmYWEiLCJlbnZpcm9ubWVudElkIjoiOWFkMTVlOWUtM2FjNi00M2Y3LWEwNTMtZDQ2Yjg3ZDZjNGE3IiwidGFyZ2V0Q2x1c3RlckVudmlyb25tZW50IjoiUFJPRCIsImlzcyI6IiBOT1RfU0VUIiwidGFyZ2V0R2VvZ3JhcGh5IjoiTkEiLCJpYXQiOjE1ODU3Njc5NDEsImdhdGV3YXlJZCI6Ijg3ZTczMzQyLWU3ZTktNDc5Yi1iNmQxLTE4Njc5MGMwMGZhYSIsImp0aSI6ImExMGVkNzgyLWE2ZmYtNDk1NC1iYjY4LThkMjhiNmZkMzkxOSJ9.UCUP3Vnan9xnA0...-"
}