GuidesChangelogAPI Reference
API Reference

/api/v5/authorize/

post
https://percolate.com/api/v5/authorize/

This API allows a user to authenticate and to create a grant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

User's login email.

ext
string

Password of user requesting authorization. Password is not required when requesting a grant while already logged-in.

string

This contains the SAML2 assertion from the user's Identity Provider. If the user has SSO configued, this should be used instead of password.

string

The tenant ID for which the authorization is requested. Required for multi-tenant users. For single-tenant users, the tenant ID is selected automatically.

string
enum
required

Identifies type of Authorization and defines ext structure. If the user only wants to create a percsession, then 'session' is used. If the user wants a grant, 'token' should be used.

Allowed:
integer

Time-Based One-Time Password obtained from RFC 6238-compliant application

string

The user ID.

Responses

Retry-After header

Updated over 2 years ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago