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
void LogoutUsingPOST (string authorization = null)
Remove User Session
Using the LogoutUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | [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 | - |
RequestPasskeyChallengeUsingPOST
PasskeyChallengeResult RequestPasskeyChallengeUsingPOST (PasskeyChallengeParameters passkeyChallengeParameters)
Request Passkey Challenge
Request passkey challenge. This API is deprecated, use /api/web/v2/authentication/users/authenticate/PASSKEY instead.
Example
Using the RequestPasskeyChallengeUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string authenticator, UserAuthenticateParameters userAuthenticateParameters, string authorization = null)
Authenticate User Challenge
Example
Using the UserAuthenticateUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authenticator | string | ||
| 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 userAuthenticateQueryParameters)
Query User Authenticators
Example
Using the UserAuthenticatorQueryUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string authenticator, UserChallengeParameters userChallengeParameters)
Request User Challenge
Example
Using the UserChallengeUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authenticator | string | ||
| 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 | - |