PingOne Platform APIs

Read One License

       

GET {{apiPath}}/organizations/{{orgID}}/licenses/{{licenseID}}

You can use GET {{apiPath}}/organizations/{{orgID}}/licenses/{{licenseID}} to view a license associated with the specified organization. The following sample shows the operation to get information about a single license. The license ID is specified in the request URL.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/organizations/{{orgID}}/licenses/{{licenseID}}' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/organizations/{{orgID}}/licenses/{{licenseID}}")
{
  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}}/organizations/{{orgID}}/licenses/{{licenseID}}"
  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 /organizations/{{orgID}}/licenses/{{licenseID}} 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}}/organizations/{{orgID}}/licenses/{{licenseID}}")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/organizations/{{orgID}}/licenses/{{licenseID}}",
  "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}}/organizations/{{orgID}}/licenses/{{licenseID}}',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/organizations/{{orgID}}/licenses/{{licenseID}}"

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}}/organizations/{{orgID}}/licenses/{{licenseID}}');
$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}}/organizations/{{orgID}}/licenses/{{licenseID}}")

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}}/organizations/{{orgID}}/licenses/{{licenseID}}")!,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/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"
        },
        "organization": {
            "href": "https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda"
        }
    },
    "advancedServices": {
        "pingId": {
            "included": true,
            "type": "FULL"
        }
    },
    "assignedEnvironmentsCount": 6,
    "authorize": {
        "allowApiAccessManagement": true,
        "allowDynamicAuthorization": true
    },
    "beginsAt": "2019-06-06T19:29:13.671Z",
    "credentials": {
        "allowCredentials": true,
        "allowPushNotifications": true
    },
    "environments": {
        "allowAddResources": true,
        "allowConnections": true,
        "allowCustomDomain": true,
        "allowCustomSchema": true,
        "allowProduction": true,
        "max": 50,
        "regions": [
            "EU",
            "NORTH_AMERICA"
        ]
    },
    "expiresAt": "2099-12-31T00:00:00.000Z",
    "fraud": {
        "allowBotMaliciousDeviceDetection": true,
        "allowAccountProtection": true,
        "allowAccountTakeoverDetection": true,
        "allowNewAccountFraudDetection": true,
        "allowCredentialSharingDetection": true,
        "allowDataEnrichment": true
    },
    "gateways": {
        "allowLdapGateway": true,
        "allowKerberosGateway": true,
        "allowRadiusGateway": true
    },
    "id": "57f0efac-37d9-4a17-8a35-196bb3362983",
    "intelligence": {
        "allowReputation": true,
        "allowGeoVelocity": true,
        "allowAnonymousNetworkDetection": true,
        "allowDataConsent": true,
        "allowRisk": true,
        "allowAdvancedPredictors": true,
        "allowIntelligenceProtect": true,
        "numberOfProtectTransactions": 0
    },
    "mfa": {
        "allowPushNotification": true,
        "allowNotificationOutsideWhitelist": true,
        "allowFido2Devices": true,
        "allowVoiceOtp": true,
        "allowEmailOtp": true,
        "allowSmsOtp": true,
        "allowTotp": true
    },
    "name": "Updated North America Test License.",
    "orchestrate": {
        "allowOrchestration": true,
        "allowAdminAccess": true,
        "flows": {
            "max": 100
        }
    },
    "organization": {
        "id": "bed432e6-676a-4ebe-b5a5-6b3b54e46bda"
    },
    "package": "INTERNAL",
    "status": "ACTIVE",
    "users": {
        "max": 10000000,
        "hardLimitMax": 11000000,
        "annualActiveIncluded": 10000000,
        "allowPasswordPolicy": true,
        "allowPasswordManagementNotifications": true,
        "allowVerificationFlow": true,
        "allowIdentityProviders": true,
        "allowMyAccount": true,
        "allowProvisioning": true,
        "allowInboundProvisioning": true,
        "allowRoleAssignment": true,
        "allowPasswordOnlyAuthentication": true,
        "allowUpdateSelf": true,
        "entitledToSupport": true
    },
    "verify": {
        "allowPushNotifications": true,
        "allowDocumentMatch": true,
        "allowFaceMatch": true,
        "allowManualIdInspection": false,
        "allowAamva": true,
        "allowVoice": true,
        "numberOfManualIDStepUpInspection": 0,
        "numberOfDigitalVerifications": 0,
        "numberOfUniversalCapture": 0,
        "numberOfAAMVA": 0,
        "numberOfVoiceBiometrics": 0
    }
}