AuthenticationApi

Method	HTTP request	Description
logout_using_post	POST /api/web/v1/authentication/logout	Remove User Session
request_passkey_challenge_using_post	POST /api/web/v1/authentication/passkey	Request Passkey Challenge
user_authenticate_using_post	POST /api/web/v1/authentication/users/authenticate/{authenticator}/complete	Authenticate User Challenge
user_authenticator_query_using_post	POST /api/web/v2/authentication/users	Query User Authenticators
user_challenge_using_post	POST /api/web/v2/authentication/users/authenticate/{authenticator}	Request User Challenge

logout_using_post

logout_using_post(authorization=authorization)

Remove User Session

Parameters

Name	Type	Description	Notes
authorization	str		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-
400	Bad Request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-

request_passkey_challenge_using_post

PasskeyChallengeResult request_passkey_challenge_using_post(passkey_challenge_parameters)

Request Passkey Challenge

Request passkey challenge. This API is deprecated, use /api/web/v2/authentication/users/authenticate/PASSKEY instead.

Example

Parameters

Name	Type	Description	Notes
passkey_challenge_parameters	PasskeyChallengeParameters

Return type

PasskeyChallengeResult

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Authenticators retrieved successfully	-
400	Bad request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-

user_authenticate_using_post

AuthenticatedResponse user_authenticate_using_post(authenticator, user_authenticate_parameters, authorization=authorization)

Authenticate User Challenge

Example

Parameters

Name	Type	Description	Notes
authenticator	str
user_authenticate_parameters	UserAuthenticateParameters
authorization	str		[optional]

Return type

AuthenticatedResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Authenticators retrieved successfully	-
400	Bad request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-

user_authenticator_query_using_post

UserAuthenticateQueryResponse user_authenticator_query_using_post(user_authenticate_query_parameters)

Query User Authenticators

Example

Parameters

Name	Type	Description	Notes
user_authenticate_query_parameters	UserAuthenticateQueryParameters

Return type

UserAuthenticateQueryResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Authenticators retrieved successfully	-
400	Bad request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-

user_challenge_using_post

AuthenticatedResponse user_challenge_using_post(authenticator, user_challenge_parameters)

Request User Challenge

Example

Parameters

Name	Type	Description	Notes
authenticator	str
user_challenge_parameters	UserChallengeParameters

Return type

AuthenticatedResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Authenticators retrieved successfully	-
400	Bad request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-