PingOne Platform APIs

Step 17: Send an authorization request

   

GET {{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}}

The PingOne authorization endpoint /{{envID}}/as/authorize is used to interact with the resource owner and obtain an authorization grant. The authorization request must include values for the following properties:

  • client_id

    A string that specifies the application’s UUID, which was returned in Step 1.

  • response_type

    A string that specifies the code or token type returned by an authorization request. For this activity, the value is code.

  • redirect_uri

    A string that specifies the URL that specifies the return entry point of the application. The redirect_uri property value is defined in Step 1.

  • scope

    A string that specifies permissions that determine the resources that the application can access. In this use case, the custom scope name is returned in Step 4.

The response returns a 302 message with a flowID embedded in the Location header, which specifies that a call should be made to another resource to continue the authentication flow. The Location header looks like this:

Location: https://apps.pingone.com/5caa81af-ec05-41ff-a709-c7378007a99c/signon/?flowId=72df1cd2-3b99-4225-a1fa-6dc9ec0f78fc

Information from the URL in the Location header will be used in the following steps of this workflow. You do not need to do anything with the Location data.

If this call fails to return a 302 HTTP Status, for a possible solution refer to Configuring and managing Postman.

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https%3A%2F%2Fwww.google.com&scope={{customResourceScopeName}}'
var options = new RestClientOptions("{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https%3A%2F%2Fwww.google.com&scope={{customResourceScopeName}}"
  method := "GET"

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

  if err != nil {
    fmt.Println(err)
    return
  }
  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 /{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}} HTTP/1.1
Host: {{authPath}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}}")
  .method("GET", body)
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}}",
  "method": "GET",
  "timeout": 0,
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}}',
  'headers': {
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}}"

payload = {}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
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("{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https://www.google.com&scope={{customResourceScopeName}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{authPath}}/{{envID}}/as/authorize?response_type=code&client_id={{CustomResourceAppID}}&redirect_uri=https%3A%2F%2Fwww.google.com&scope={{customResourceScopeName}}")!,timeoutInterval: Double.infinity)
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

302 Moved Temporarily