Select
Schemas
WebAuthnRegistrationRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
username | string | false | none |
user_verification | string | false | none |
attestation | string | false | none |
attachment | string | false | none |
algorithms | [string] | false | none |
discoverable_credential | string | false | none |
WebAuthnRegistrationResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
rp | object | false | none |
» name | string | false | none |
» id | string | false | none |
user | object | false | none |
» name | string | false | none |
» displayName | string | false | none |
» id | string | false | none |
challenge | string | false | none |
pubKeyCredParams | [object] | false | none |
» type | string | false | none |
» alg | integer | false | none |
timeout | integer | false | none |
authenticatorSelection | object | false | none |
» requireResidentKey | boolean | false | none |
» userVerification | string | false | none |
WebAuthnVerifyRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
username | string | false | none |
response | object | false | none |
» id | string | false | none |
» rawId | string | false | none |
» response | object | false | none |
»» attestationObject | string | true | none |
»» clientDataJSON | string | true | none |
»» transports | [string] | true | none |
»» publicKeyAlgorithm | integer | true | none |
»» publicKey | string | true | none |
»» authenticatorData | string | true | none |
» type | string | false | none |
» clientExtensionResults | object | false | none |
» authenticatorAttachment | string | false | none |
WebAuthnVerifyResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
verified | boolean | false | none |
WebAuthnAuthenticationOptionsRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
username | string | false | none |
user_verification | string | false | none |
WebAuthnAuthenticationOptionsResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
challenge | string | false | none |
timeout | integer | false | none |
rpId | string | false | none |
allowCredentials | [object] | false | none |
» type | string | false | none |
» id | string | false | none |
» transports | [string] | false | none |
userVerification | string | false | none |
WebAuthnAuthenticationVerificationRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
username | string | true | none |
response | object | true | none |
» id | string | true | none |
» rawId | string | true | none |
» response | object | true | none |
»» authenticatorData | string | true | none |
»» clientDataJSON | string | true | none |
»» signature | string | true | none |
»» userHandle | string | false | none |
» type | string | true | none |
» clientExtensionResults | object | false | none |
» authenticatorAttachment | string | false | none |
WebAuthnAuthenticationVerificationResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
access_token | string | true | none |
expires_in | integer | true | none |
refresh_token | string | true | none |
token_type | string | true | none |
accessTokenResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
access_token | string | true | A token used by the client to make authenticated requests on behalf of the resource owner |
scope | string | false | Scopes |
expires_in | integer | false | none |
token_type | string | true | none |
refresh_token | string | false | A token used by the client to obtain a new access token without having to involve the resource owner. |
bcAuthorizeResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
auth_req_id | string | true | REQUIRED. This is a unique identifier to identify the authentication request made by the Client. |
expires_in | integer | true | The duration in seconds for which the authentication request is valid. |
interval | integer | true | The minimum amount of time in seconds that the client SHOULD wait between polling to check if the authentication request has been completed. |
deviceCodeAuthorizeResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
device_code | string | true | REQUIRED. The unique code used for device verification. |
user_code | string | true | REQUIRED. The human-readable user code to be displayed to the user. |
verification_uri | string | true | REQUIRED. The end-user verification URI on the authorization server. The URI should be short and easy to remember as end users will be asked to manually type it into their user agent. |
verification_uri_complete | string | false | A verification URI that includes the "user_code" (or other information with the same function as the "user_code"), which is designed for non-textual transmission. |
qr_code | string | true | REQUIRED. The base64 encoded QR code image data. |
expires_in | integer | true | REQUIRED. The lifetime in seconds of the “device_code” and “user_code” |
interval | integer | false | The minimum amount of time in seconds that the client SHOULD wait between polling requests to the token endpoint. If no value is provided, clients MUST use 5 as the default. |
tokenClaims
|
|
Name | Type | Required | Description |
---|---|---|---|
tid | string | true | tid |
cid | string | true | cid |
scope | string | true | Scopes |
strength | string | false | describes token level of security |
exp | integer | false | none |
aud | string | false | none |
iat | string | false | issued at |
iss | integer | false | http://localhost:6040 |
sub | string | false | subject |
preferred_username | string | false | user_name |
tenants | string | false | none |
tenants_translation | [object] | false | none |
» tenant_id | string | false | Internal id |
» org | string | false | public name |
groups | string | false | none |
roles | string | false | none |
permissions | string | false | none |
family_name | string | false | none |
given_name | string | false | none |
require_password_change | boolean | false | none |
errorAccessTokenResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
error | string | true | A single error code |
error_description | string | false | A human-readable text providing additional information, used to assist in the understanding and resolution of the error occurred |
error_uri | string | false | none |
Property | Values |
---|---|
error | one of [invalid_request, access_denied, invalid_client, invalid_grant, unauthorized_client, unauthorized_grant_type, invalid_scope, error_description, error_uri] |
goError
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | true | Unique identifier of error |
status | integer | true | Status code of the response |
msg | string | false | Final user message |
componentMsg | string | false | Technical message |
sentryCode | string | false | Unique identifier to use in sentry |
tokenInfoRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
access_token | string | true | A valid access token provided by authn |
logoutRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
token | string | false | A valid token (access_token or refresh_token) provided by authn |
scope | string | false | If the value is all, it will delete all the user’s sessions and refresh_tokens that it has. |
openid-configuration
|
|
Name | Type | Required | Description |
---|---|---|---|
token_endpoint | string | false | none |
token_endpoint_auth_methods_supported | [string] | false | none |
jwks_uri | string | false | none |
response_modes_supported | [string] | false | none |
subject_types_supported | [string] | false | none |
id_token_signing_alg_values_supported | [string] | false | none |
response_types_supported | [string] | false | none |
scopes_supported | [string] | false | none |
issuer | string | false | none |
request_uri_parameter_supported | boolean | false | none |
userinfo_endpoint | string | false | none |
authorization_endpoint | string | false | none |
http_logout_supported | boolean | false | none |
frontchannel_logout_supported | boolean | false | none |
end_session_endpoint | string | false | none |
claims_supported | [string] | false | none |
jwk
|
|
Name | Type | Required | Description |
---|---|---|---|
alg | string | false | The “alg” (algorithm) member identifies the algorithm intended for use with the key |
kty | string | false | The “kty” (key type) member identifies the cryptographic algorithm family used with the key, such as “RSA” or “EC”. “kty” values should either be registered in the IANA JSON Web Key Types registry defined in [JWA] or be a value that contains a Collision-Resistant Name. The “kty” value is a case-sensitive string. |
use | string | false | The “use” (public key use) member identifies the intended use of the public key. The “use” parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. |
x5c | [string] | false | The “x5c” (X.509 Certificate Chain) member contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64 encoded ([RFC4648] Section 4 – not base64url encoded) DER [ITU.X690.1994] PKIX certificate value |
n | string | false | none |
e | string | false | none |
kid | string | false | The “kid” (key ID) member is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover |
x5t | string | false | The “x5t” (X.509 Certificate SHA-1 Thumbprint) member is a base64url encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate [RFC5280]. |
Property | Values |
---|---|
use | one of [sig, enc] |
jwks
|
|
Name | Type | Required | Description |
---|---|---|---|
keys | [jwk] | true | The JSON object MUST have a “keys” member, which is an array of JWKs. |