Initiate an Authorization Transaction

get

https://na1.ironcladapp.com/oauth/authorize

This endpoint is used to request authorization from a user to access their Ironclad data on their behalf. This is the initial request of an Authorization Code grant flow. The client application generally initiates the authorization flow, where a user will be redirected to Ironclad to log in and grant the requested permissions. The user is then redirected back to the client application redirect URI with an authorization code. See endpoint specification.

Query Params

response_type

string

enum

required

The expected response type for the request. Must be set to 'code' for the Authorization Code grant.

Allowed:

client_id

string

required

The client ID of the client application issued at registration.

redirect_uri

string

required

The client applications redirect URI. Must be registered on the client application and consistent throughout the authorization transaction.

scope

string

Specifies the level of access that your client application is requesting. It should be a space-separated string of Ironclad resource scopes that can be found on the client application registration page. The scopes requested must be equal to or a subset of the client application’s registered scopes.

state

string

An opaque value used by the client application to maintain state between the request and callback. The authorization server includes this value when redirecting the user back to the client application.

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

400If the request is missing required parameters or has invalid parameters, the client will receive an 'invalid_request' response.

403If the client application is not authorized to use a specific grant type, the client will receive an 'unauthorized_client' response.