Documentação - Documentação

post https://console.iugu.com/authorize

OAuth2 authorization endpoint

Starts the OAuth2 authorization flow. Validates the client, redirect URI, requested ACR profile and optional PKCE parameters, then issues an authorization code (response_type=code) or an access token (response_type=token) and redirects to the client callback URL.

Sem ações implementadas definidas

Request

Body Required

Content Type: application/x-www-form-urlencoded

client_id

String

The application (client) short ID.

Ex: 4fHECmQtLdROI4fDLWMiLd

response_type

String
Enum: `code`, `token`

The OAuth2 response type.

redirect_uri

String

One of the client's registered callback URLs.

Ex: https://app.example.com/callback

acr_values

String
Enum: `urn:iugu:grant_scopes:informations`, `urn:iugu:grant_scopes:config`, `urn:iugu:grant_scopes:transfers`

The requested authentication context (grant scope).

scope

String

Space separated list of requested scopes.

Ex: informations

audience

String

Intended audience for the issued token.

Ex: Iugu.Platform.3W3pZX7CxbPGjC8WDTmunA

nonce

String

Value used to associate a client session with an ID token.

code_challenge

String

PKCE code challenge (only for response_type=code).

code_challenge_method

String
Enum: `plain`, `S256`

PKCE code challenge method.

key

String

Identifier of the certificate used to decrypt protected_data.

protected_data

String

Encrypted payload with the subject, session and workspace context.

Example

1
{}

Response

302
Redirect to the client callback URL with the code or token.

400

Bad Request

error_type

String

The OAuth2 error type.

Ex: invalid_client

error_description

String

Human readable error message.

Ex: The client is unregistered or could not be authenticated

Example

1
2
3
4
{
  "error_type": "invalid_client",
  "error_description": "The client is unregistered or could not be authenticated"
}

401

Unauthorized

error_type

String

The OAuth2 error type.

Ex: invalid_client

error_description

String

Human readable error message.

Ex: The client is unregistered or could not be authenticated

Example

1
2
3
4
{
  "error_type": "invalid_client",
  "error_description": "The client is unregistered or could not be authenticated"
}

Back

Installed apps

Forward

OAuth2 token endpoint