authentication

OAuth2 authentication.

post /auth/logout

Arguments

  • No arguments...

Definition
post /auth/logout

post /auth/login

OAuth 2 authentication via HTTP basic authentication, see Section 4.4 of RFC 6749 for details.

Arguments

  • grant_typeoptionalstring

    OAuth 2 grant type, must be set to "client_credentials" for this endpoint.

Definition
post /auth/login
Attributes

  • access_tokenstring

    Access token, should be handled as an opaque value as the format may change in the future.

  • token_typestring

    OAuth2 token type, always "bearer".

  • expires_innumber

    Duration in seconds.

  • rolesarray

    All roles of the user the token is associated with.

  • userIdinteger

    Internal id of the user this token is associated with.

  • passwordWasNeverChangedboolean

    Set if the user never changed their password.

Example response
{ "access_token": "string", "token_type": "string", "expires_in": , "roles": [ "string" ], "userId": 0, "passwordWasNeverChanged": true }

post /auth/login-form

OAuth 2 authentication with all parameters as url-encoded form, see Section 4.3 of RFC 6749 for details.

Arguments

  • grant_typeoptionalstring

    OAuth 2 grant type, must be set to "password" for this endpoint.

  • usernameoptionalstring

    User name of the croit or LDAP user.

  • passwordoptionalstring

    Plaintext password.

Definition
post /auth/login-form
Attributes

  • access_tokenstring

    Access token, should be handled as an opaque value as the format may change in the future.

  • token_typestring

    OAuth2 token type, always "bearer".

  • expires_innumber

    Duration in seconds.

  • rolesarray

    All roles of the user the token is associated with.

  • userIdinteger

    Internal id of the user this token is associated with.

  • passwordWasNeverChangedboolean

    Set if the user never changed their password.

Example response
{ "access_token": "string", "token_type": "string", "expires_in": , "roles": [ "string" ], "userId": 0, "passwordWasNeverChanged": true }

get /auth/token-info

Arguments

  • No arguments...

Definition
get /auth/token-info
Attributes

  • usernamestring

    -

  • rolesarray

    -

  • expiryinteger

    -

Example response
{ "username": "string", "roles": [ "string" ], "expiry": 0 }

get /auth/okta/signInConfig

Arguments

  • No arguments...

Definition
get /auth/okta/signInConfig
Attributes

  • baseUrlstring

    -

  • clientIdstring

    -

  • issuerstring

    -

  • audiencestring

    -

  • mapRolesobject

    -

Example response
{ "baseUrl": "string", "clientId": "string", "issuer": "string", "audience": "string", "mapRoles": {} }

post /auth/okta/login

Arguments

  • bodyoptional

    -

Definition
post /auth/okta/login
Attributes

  • access_tokenstring

    Access token, should be handled as an opaque value as the format may change in the future.

  • token_typestring

    OAuth2 token type, always "bearer".

  • expires_innumber

    Duration in seconds.

  • rolesarray

    All roles of the user the token is associated with.

  • userIdinteger

    Internal id of the user this token is associated with.

  • passwordWasNeverChangedboolean

    Set if the user never changed their password.

Example response
{ "access_token": "string", "token_type": "string", "expires_in": , "roles": [ "string" ], "userId": 0, "passwordWasNeverChanged": true }