API docs by Redocly

Autentico OIDC (1.0)

Download OpenAPI specification:

Authentication Service

Well-Known

Get JWKS

Returns the JSON Web Key Set for verifying JWTs

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Get Well-Known Configuration

Returns the OpenID Connect Well-Known Configuration

Responses

Response samples

Content type
application/json
{
  • "authorization_endpoint": "string",
  • "claims_supported": [
    ],
  • "end_session_endpoint": "string",
  • "id_token_signing_alg_values_supported": [
    ],
  • "issuer": "string",
  • "jwks_uri": "string",
  • "registration_endpoint": "string",
  • "response_types_supported": [
    ],
  • "scopes_supported": [
    ],
  • "subject_types_supported": [
    ],
  • "token_endpoint": "string",
  • "token_endpoint_auth_methods_supported": [
    ],
  • "userinfo_endpoint": "string"
}

authorize

Authorize a client

Handles the authorization request and displays the login page

query Parameters
response_type
required
string

Response type

client_id
required
string

Client ID

redirect_uri
required
string

Redirect URI

scope
string

Scope

state
required
string

State

Responses

introspect

Introspect a token

Validates and retrieves metadata about a token

Request Body schema: application/json
required

Token introspection payload

token
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "aud": "string",
  • "client_id": "string",
  • "error": "string",
  • "error_description": "string",
  • "exp": 0,
  • "iat": 0,
  • "jti": "string",
  • "nbf": 0,
  • "scope": "string",
  • "sub": "string",
  • "token_type": "string",
  • "username": "string"
}

auth

Log in a user

Authenticates a user and generates an authorization code

Request Body schema: application/x-www-form-urlencoded
required
username
required
string

Username

password
required
string

Password

redirect
required
string

Redirect URI

state
required
string

State

Responses

Response samples

Content type
application/json
"string"

session

Log out a user

Terminates the user's session

header Parameters
Authorization
required
string

Bearer access token

Responses

Response samples

Content type
application/json
"string"

client

List all clients

Lists all registered clients (admin only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Register a new OAuth2 client

Registers a new OAuth2/OIDC client (admin only)

Request Body schema: application/json
required

Client registration request

client_name
string
client_type
string
grant_types
Array of strings
redirect_uris
Array of strings
response_types
Array of strings
scopes
string
token_endpoint_auth_method
string

Responses

Request samples

Content type
application/json
{
  • "client_name": "string",
  • "client_type": "string",
  • "grant_types": [
    ],
  • "redirect_uris": [
    ],
  • "response_types": [
    ],
  • "scopes": "string",
  • "token_endpoint_auth_method": "string"
}

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "client_name": "string",
  • "client_secret": "string",
  • "client_secret_expires_at": 0,
  • "client_type": "string",
  • "grant_types": [
    ],
  • "redirect_uris": [
    ],
  • "response_types": [
    ],
  • "scopes": "string",
  • "token_endpoint_auth_method": "string"
}

Deactivate a client

Deactivates (soft deletes) a registered client (admin only)

path Parameters
client_id
required
string

Client ID

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Get client information

Retrieves information about a registered client (admin only)

path Parameters
client_id
required
string

Client ID

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "client_name": "string",
  • "client_type": "string",
  • "grant_types": [
    ],
  • "is_active": true,
  • "redirect_uris": [
    ],
  • "response_types": [
    ],
  • "scopes": "string",
  • "token_endpoint_auth_method": "string"
}

Update client information

Updates a registered client (admin only)

path Parameters
client_id
required
string

Client ID

Request Body schema: application/json
required

Client update request

client_name
string
grant_types
Array of strings
is_active
boolean
redirect_uris
Array of strings
response_types
Array of strings
scopes
string
token_endpoint_auth_method
string

Responses

Request samples

Content type
application/json
{
  • "client_name": "string",
  • "grant_types": [
    ],
  • "is_active": true,
  • "redirect_uris": [
    ],
  • "response_types": [
    ],
  • "scopes": "string",
  • "token_endpoint_auth_method": "string"
}

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "client_name": "string",
  • "client_type": "string",
  • "grant_types": [
    ],
  • "is_active": true,
  • "redirect_uris": [
    ],
  • "response_types": [
    ],
  • "scopes": "string",
  • "token_endpoint_auth_method": "string"
}

token

Revoke a token

Revokes an access or refresh token

Request Body schema: application/x-www-form-urlencoded
required
token
required
string

Token to revoke

Responses

Response samples

Content type
application/json
"string"

Token endpoint

Exchanges authorization code or credentials for tokens

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string

Grant type

code
string

Authorization code

redirect_uri
string

Redirect URI

client_id
string

Client ID

username
string

Username

password
string

Password

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "refresh_token": "string",
  • "scope": "string",
  • "token_type": "string"
}

userinfo

Get user information

Retrieves user information based on the access token

header Parameters
Authorization
required
string

Bearer access token

Responses

Response samples

Content type
application/json
{ }

users

Create a new user

Registers a new user in the system

Request Body schema: application/json
required

User creation payload

email
string
password
string
role
string

optional role assignment

username
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "role": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "email": "string",
  • "id": "string",
  • "role": "string",
  • "username": "string"
}