v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Authorization

Initiate an Authorization Transaction

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.

get/authorize

Query parameters

response_type'code' required

Example:code

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

client_idstring required

Example:6013609108b8f070cee94fc1

The client ID of the client application issued at registration.

redirect_uristring required

Example:https://myapp.com/oauth/callback

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

scopestring

Example:public.records.readRecords public.records.createRecords

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.

statestring

Example:1234567890

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.