AuthenticationApi
| Method | HTTP request | Description |
|---|---|---|
| logoutUsingPOST | POST /api/web/v1/authentication/logout | Remove User Session |
| requestPasskeyChallengeUsingPOST | POST /api/web/v1/authentication/passkey | Request Passkey Challenge |
| userAuthenticateUsingPOST | POST /api/web/v1/authentication/users/authenticate/{authenticator}/complete | Authenticate User Challenge |
| userAuthenticatorQueryUsingPOST | POST /api/web/v2/authentication/users | Query User Authenticators |
| userChallengeUsingPOST | POST /api/web/v2/authentication/users/authenticate/{authenticator} | Request User Challenge |
logoutUsingPOST
logoutUsingPOST(authorization)
Remove User Session
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | String | [optional] |
Return type
null (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 | - |
requestPasskeyChallengeUsingPOST
PasskeyChallengeResult requestPasskeyChallengeUsingPOST(passkeyChallengeParameters)
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 |
|---|---|---|---|
| passkeyChallengeParameters | PasskeyChallengeParameters |
Return type
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 | - |
userAuthenticateUsingPOST
AuthenticatedResponse userAuthenticateUsingPOST(authenticator, userAuthenticateParameters, authorization)
Authenticate User Challenge
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authenticator | String | [enum: MACHINE, PASSWORD, EXTERNAL, KBA, TEMP_ACCESS_CODE, OTP, GRID, TOKEN, TOKENPUSH, FIDO, SMARTCREDENTIALPUSH, PASSWORD_AND_SECONDFACTOR, SMART_LOGIN, IDP, PASSKEY, IDP_AND_SECONDFACTOR, USER_CERTIFICATE, FACE] | |
| userAuthenticateParameters | UserAuthenticateParameters | ||
| authorization | String | [optional] |
Return type
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 | - |
userAuthenticatorQueryUsingPOST
UserAuthenticateQueryResponse userAuthenticatorQueryUsingPOST(userAuthenticateQueryParameters)
Query User Authenticators
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userAuthenticateQueryParameters | UserAuthenticateQueryParameters |
Return type
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 | - |
userChallengeUsingPOST
AuthenticatedResponse userChallengeUsingPOST(authenticator, userChallengeParameters)
Request User Challenge
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authenticator | String | [enum: MACHINE, PASSWORD, EXTERNAL, KBA, TEMP_ACCESS_CODE, OTP, GRID, TOKEN, TOKENPUSH, FIDO, SMARTCREDENTIALPUSH, PASSWORD_AND_SECONDFACTOR, SMART_LOGIN, IDP, PASSKEY, IDP_AND_SECONDFACTOR, USER_CERTIFICATE, FACE] | |
| userChallengeParameters | UserChallengeParameters |
Return type
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 | - |