Login

Oauth:Login

post

Authenticates the user and returns an access token.

This endpoint supports two grant types:

• standard OAuth2 password grant type - only supported for the admin user and only available if the admin account is enabled
• standard OAuth2 device authorization grant type

Args: request: The request object. response: The response object. auth_form_data: The authentication form data. user_manager: The user manager. workspace_manager: The workspace manager.

Returns: An admin access token.

Raises: ValueError: If the grant type is invalid.

Body

application/x-www-form-urlencoded

grant_typeany ofOptional

stringOptional

or

nullOptional

usernameany ofOptional

stringOptional

or

nullOptional

passwordany ofOptional

stringOptional

or

nullOptional

client_idany ofOptional

stringOptional

or

nullOptional

client_secretany ofOptional

stringOptional

or

nullOptional

device_codeany ofOptional

stringOptional

or

nullOptional

audienceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/auth/login

HTTPcURLJavaScriptPython

POST /auth/login HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 138

"grant_type='text'&username='text'&password='text'&client_id='text'&client_secret='text'&device_code='text'&audience='text'"

{
  "access_token": "text",
  "expires_in": 1,
  "token_type": "bearer",
  "device_id": "text",
  "device_metadata": {}
}