PingOne Platform APIs

Step 15: Send authorize request

   

GET {{authPath}}/{{envID}}/as/authorize?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}

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 defined in Step 1 is https://example.com.

  • login_hint_token

    A string that specifies a token that provides a way for the client to identify and authenticate the end-user without needing to encode the entire authentication request in a signed JWT.

Create the signed login_hint_token

To submit an MFA only authorize request, you must create a login_hint_token that provides the following user and application information in the JWT:

  • Environment ID: The environment ID for the environment associated with the user.

  • Application ID: The application to which the user is making the authorization request.

  • Application secret: The application’s secret.

  • User ID or username: The user ID or the username of the user.

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{authPath}}/{{envID}}/as/authorize?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}'
var options = new RestClientOptions("{{authPath}}/{{envID}}/as/authorize?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}")
{
  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?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}"
  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?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}} 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?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}")
  .method("GET", body)
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{authPath}}/{{envID}}/as/authorize?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}",
  "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?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}',
  'headers': {
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{authPath}}/{{envID}}/as/authorize?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}"

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?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}');
$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?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}")

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?client_id={{webApp4MfaId}}&response_type=code&response_mode=pi.flow&login_hint_token={{requestParam}}")!,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

200 OK

{
    "_links": {
        "otp.check": {
            "href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/03101bf2-7eed-41ca-a326-1f47061eb434"
        },
        "device.select": {
            "href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/03101bf2-7eed-41ca-a326-1f47061eb434"
        },
        "self": {
            "href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/03101bf2-7eed-41ca-a326-1f47061eb434"
        },
        "signOnPage": {
            "href": "https://apps.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signon/?flowId=03101bf2-7eed-41ca-a326-1f47061eb434"
        }
    },
    "_embedded": {
        "devices": [
            {
                "id": "3d9dd925-6aef-4267-a9f6-2e7824c18d33",
                "type": "SMS",
                "status": "ACTIVE",
                "userRetries": 0,
                "phone": "*******01"
            }
        ],
        "application": {
            "name": "WebAppWithMFA_1626821450"
        }
    },
    "id": "03101bf2-7eed-41ca-a326-1f47061eb434",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "resumeUrl": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/as/resume?flowId=03101bf2-7eed-41ca-a326-1f47061eb434",
    "status": "OTP_REQUIRED",
    "createdAt": "2021-07-20T22:51:31.743Z",
    "expiresAt": "2021-07-20T23:06:32.005Z",
    "bypassAllowed": false,
    "selectedDevice": {
        "id": "3d9dd925-6aef-4267-a9f6-2e7824c18d33"
    }
}