AuthApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| generateNewApiKey | PATCH /auth/profile/apikey | Update ApiKey |
| isAuthenticated | GET /auth/authenticated | Check Authentication |
| login | POST /auth/login | Login User |
| logout | POST /auth/logout | Logout User |
| logoutByDelete | DELETE /auth/logout | Logout User |
| refreshToken | GET /auth/token/refresh | Refresh User |
| updatePassword | PATCH /auth/profile/password | Update Password |
| userProfile | GET /auth/profile | User Profile |
generateNewApiKey
JsonValue_String generateNewApiKey()
Update ApiKey
Generate new ApiKey of logged in User
Parameters
This endpoint does not need any parameter.
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
isAuthenticated
JsonValue_Boolean isAuthenticated()
Check Authentication
Check a given Login for is authenticated
Parameters
This endpoint does not need any parameter.
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
login
LoginResult login(Login)
Login User
Login for one user and return Login Information
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| Login | Login | Login Information for your Users |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
logout
JsonValue_Boolean logout()
Logout User
Logout by bearer Token
Parameters
This endpoint does not need any parameter.
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
logoutByDelete
JsonValue_Boolean logoutByDelete()
Logout User
Logout by bearer Token
Parameters
This endpoint does not need any parameter.
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
refreshToken
LoginResult refreshToken()
Refresh User
Refresh Token and return Login Information
Parameters
This endpoint does not need any parameter.
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
updatePassword
JsonValue_Boolean updatePassword(PasswordUpdateRequest)
Update Password
Change Password of logged in User
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| PasswordUpdateRequest | PasswordUpdateRequest |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
userProfile
UserProfile userProfile()
User Profile
Return the User Profile of loggedin user
Parameters
This endpoint does not need any parameter.
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json