API¶
- GET /user¶
Read Root
Retrieve user API information:
description
available endpoints
security
- Status Codes:
200 OK – Successful Response
- GET /user/get_status¶
Get Status
Get information about your local account:
state: one of the supported states, such as deployed, not_deployed, suspended.
message: could contain additional information, such as the local username
Requires an authorised user.
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- Request Headers:
Authorization – OIDC Access Token (Required)
- GET /user/deploy¶
Deploy
Provision a local account.
Requires an authorised user.
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- Request Headers:
Authorization – OIDC Access Token (Required)
- GET /user/suspend¶
Suspend
Suspends a local account.
Requires an authorised user.
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- Request Headers:
Authorization – OIDC Access Token (Required)
- GET /user/generate_otp¶
Generate Otp
Generates and stores a new one-time password, using token as shared secret.
Requires an authorised user.
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- Request Headers:
Authorization – OIDC Access Token (Required)
- GET /admin¶
Read Root
Retrieve admin API information:
description
available endpoints
security
- Status Codes:
200 OK – Successful Response
- GET /admin/suspend¶
Suspend
Suspends a local account mapped to given OIDC account – uniquely identified by issuer and subject claims.
Requires a user with admin rights.
- Query Parameters:
sub (string) – sub claim of the user to be suspended (Required)
iss (string) – OIDC provider of user to be suspended (Required)
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- Request Headers:
Authorization – OIDC Access Token (Required)
- GET /admin/resume¶
Resume
Resumes a suspended local account mapped to given OIDC account – uniquely identified by issuer and subject claims.
Requires a user with admin rights.
- Query Parameters:
sub (string) – sub claim of the user to be suspended (Required)
iss (string) – OIDC provider of user to be suspended (Required)
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- Request Headers:
Authorization – OIDC Access Token (Required)
- GET /¶
Read Root
Retrieve general API information:
description
available endpoints
security
- Status Codes:
200 OK – Successful Response
- GET /info¶
Info
Retrieve service-specific information:
login info
supported OPs
ops_info per OP information, such as scopes, audience, etc.
- Status Codes:
200 OK – Successful Response
- GET /info/authorisation¶
Info Authorisation
Retrieve authorisation information for specific OP.
Requires:
that the OP is supported
authentication with this OP
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- Request Headers:
Authorization – OIDC Access Token (Required)
- GET /info/op¶
Info Op
Retrieve additional information for specific OP, such as required scopes.
- Query Parameters:
url (string) – OP URL (Required)
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- GET /verify_user¶
Verify User
Verify that the authenticated user has a local account with the given username.
Requires the user to be authorised on the service.
- Query Parameters:
username (string) – username to compare to local username (Required)
- Status Codes:
200 OK – Successful Response
401 Unauthorized – Unauthorized
403 Forbidden – Forbidden
404 Not Found – Not Found
422 Unprocessable Entity – Validation Error
- Request Headers:
Authorization – OIDC Access Token or valid one-time token (Required)