authentication

OAuth2 authentication.
get /auth/oidc

List of all OIDC configs.

Parameters
pagination string query
Responses
200 successful operation
OidcConfigResponse array
OidcConfigResponse object 
[
  {
    "id": 0,
    "name": "string",
    "scope": "string",
    "jwksUrl": "string",
    "clientId": "string",
    "tokenUrl": "string",
    "issuerUrl": "string",
    "clientAuth": "None",
    "manualRoles": true,
    "roleMapping": {
      "additionalProp1": "admin",
      "additionalProp2": "admin",
      "additionalProp3": "admin"
    },
    "userinfoUrl": "string",
    "authorizeUrl": "string",
    "clientSecret": "string",
    "defaultRoles": [
      "admin"
    ],
    "discoveryUrl": "string",
    "groupPointer": "string",
    "providerName": "string",
    "callbackBaseUri": "string",
    "clientAuthLabel": "string",
    "defaultMaxExpiry": 0,
    "defaultMinExpiry": 0,
    "roleMappingFormatted": "string"
  }
]
post /auth/oidc
Parameters
body object 
{
  "name": "string",
  "scope": "string",
  "jwksUrl": "string",
  "clientId": "string",
  "tokenUrl": "string",
  "issuerUrl": "string",
  "clientAuth": "None",
  "manualRoles": true,
  "roleMapping": {
    "additionalProp1": "admin",
    "additionalProp2": "admin",
    "additionalProp3": "admin"
  },
  "userinfoUrl": "string",
  "authorizeUrl": "string",
  "clientSecret": "string",
  "defaultRoles": [
    "admin"
  ],
  "discoveryUrl": "string",
  "groupPointer": "string",
  "callbackBaseUri": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
post /auth/login

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

Parameters
grant_type string formData
OAuth 2 grant type, must be set to "client_credentials" for this endpoint.
Responses
200 successful operation
Token object 
{
  "roles": [
    "string"
  ],
  "userId": 0,
  "expires_in": 0,
  "token_type": "string",
  "access_token": "string",
  "passwordWasNeverChanged": true
}
post /auth/logout
Responses
default successful operation
get /auth/oidc/{id}
Parameters
id integer path Required
Responses
200 successful operation
OidcConfigResponse object 
{
  "id": 0,
  "name": "string",
  "scope": "string",
  "jwksUrl": "string",
  "clientId": "string",
  "tokenUrl": "string",
  "issuerUrl": "string",
  "clientAuth": "None",
  "manualRoles": true,
  "roleMapping": {
    "additionalProp1": "admin",
    "additionalProp2": "admin",
    "additionalProp3": "admin"
  },
  "userinfoUrl": "string",
  "authorizeUrl": "string",
  "clientSecret": "string",
  "defaultRoles": [
    "admin"
  ],
  "discoveryUrl": "string",
  "groupPointer": "string",
  "providerName": "string",
  "callbackBaseUri": "string",
  "clientAuthLabel": "string",
  "defaultMaxExpiry": 0,
  "defaultMinExpiry": 0,
  "roleMappingFormatted": "string"
}
put /auth/oidc/{id}
Parameters
id integer path Required
body object 
{
  "name": "string",
  "scope": "string",
  "jwksUrl": "string",
  "clientId": "string",
  "tokenUrl": "string",
  "issuerUrl": "string",
  "clientAuth": "None",
  "manualRoles": true,
  "roleMapping": {
    "additionalProp1": "admin",
    "additionalProp2": "admin",
    "additionalProp3": "admin"
  },
  "userinfoUrl": "string",
  "authorizeUrl": "string",
  "clientSecret": "string",
  "defaultRoles": [
    "admin"
  ],
  "discoveryUrl": "string",
  "groupPointer": "string",
  "callbackBaseUri": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
delete /auth/oidc/{id}
Parameters
id integer path Required
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
post /auth/login-form

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

Parameters
grant_type string formData
OAuth 2 grant type, must be set to "password" for this endpoint.
username string formData
User name of the croit or LDAP user.
password string formData
Plaintext password.
Responses
200 successful operation
Token object 
{
  "roles": [
    "string"
  ],
  "userId": 0,
  "expires_in": 0,
  "token_type": "string",
  "access_token": "string",
  "passwordWasNeverChanged": true
}
post /auth/okta/login
Parameters
body object 
{
  "idToken": "string"
}
Responses
200 successful operation
Token object 
{
  "roles": [
    "string"
  ],
  "userId": 0,
  "expires_in": 0,
  "token_type": "string",
  "access_token": "string",
  "passwordWasNeverChanged": true
}
get /auth/token-info
Responses
200 successful operation
TokenInfoReply object 
{
  "roles": [
    "string"
  ],
  "expiry": 0,
  "oidcId": 0,
  "username": "string",
  "oidcSubject": "string"
}
post /auth/oidc/callback
Parameters
error string query
code string query
state string query
Responses
200 successful operation
Token object 
{
  "roles": [
    "string"
  ],
  "userId": 0,
  "expires_in": 0,
  "token_type": "string",
  "access_token": "string",
  "passwordWasNeverChanged": true
}
get /auth/oidc/providers
Responses
200 successful operation
OidcProvider array
OidcProvider object 
[
  {
    "id": 0,
    "name": "string"
  }
]
get /auth/oidc/{id}/login
Parameters
id integer path Required
Responses
default successful operation
get /auth/okta/signInConfig
Responses
200 successful operation
OktaOAuthConfig object 
{
  "issuer": "string",
  "baseUrl": "string",
  "audience": "string",
  "clientId": "string",
  "mapRoles": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
post /auth/oidc/{id}/invalidate
Parameters
id integer path Required
Responses
default successful operation