Skip to main content
GET
Get the current API client
Use it to check which credentials a token carries, and to find the IDs of your realm and organizations for the other endpoints. Any problem with the token answers 401 Unauthorized.

Response

200 - application/json

Successful response

The authenticated API client.

id
string<uuid>
required

ID of the API client.

Example:

"43230779-2cfb-4525-a40c-77fbf15e68f0"

email
string
required

The API client's clientId followed by @portao3.com.br.

Example:

"prod-client-v2@portao3.com.br"

name
string
required

The API client's clientId.

Example:

"prod-client-v2"

realm
object
required

The realm the API client belongs to.

status
enum<string>
required

Status of the API client. Tokens are only issued to ACTIVE API clients, so it is always ACTIVE here.

Available options:
IN_ONBOARDING,
CREATING,
ACTIVE,
DEACTIVATED,
BLOCKED
Example:

"ACTIVE"

organizations
object[]
required

Organizations the API client can act on.