auth

Scout API 1.0.0 — see schemas for shared types.

POST /api/auth/api-tokens

create_api_token

Request body

Content-Type: application/json

Schema: CreateApiTokenRequest

Responses

• 200 — OK
• application/json → ApiTokensTokenResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/auth/api-tokens/

get_api_tokens

Responses

• 200 — OK
• application/json → ApiTokensResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/auth/api-tokens/

create_api_token

Request body

Content-Type: application/json

Schema: CreateApiTokenRequest

Responses

• 200 — OK
• application/json → ApiTokensTokenResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/auth/api-tokens/{token_id}

get_api_token

Parameters

Name	In	Type	Required	Description
token_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → ApiTokensTokenResponse
• 422 — Unprocessable Content
• application/json → ValidationError

PUT /api/auth/api-tokens/{token_id}/

update_api_token

Parameters

Name	In	Type	Required	Description
token_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: UpdateApiTokenBody

Responses

• 200 — OK
• application/json → ApiTokensTokenResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/auth/api-tokens/{token_id}/revoke/

revoke_api_token

Parameters

Name	In	Type	Required	Description
token_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → RevokeApiTokenResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/auth/check/

check_auth

Responses

• 200 — OK
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/auth/decode_access_token/

decode_access_token

Responses

• 200 — OK
• application/json → DecodedAccessTokenResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/auth/login/

login

Request body

Content-Type: application/json

Schema: LoginRequest

Responses

• 200 — OK
• application/json → LoginResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/auth/logout/

logout

Request body

Content-Type: application/json

Schema: LogoutRequest

Responses

• 200 — OK
• application/json → LogoutResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/auth/refresh-impersonation/

refresh_impersonation

Responses

• 200 — OK
• application/json → LoginResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/auth/refresh/

refresh

Responses

• 200 — OK
• application/json → RefreshTokenResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/auth/switch-tenant

switch_tenant

Request body

Content-Type: application/json

Schema: SwitchTenantRequest

Responses

• 200 — OK
• application/json → LoginResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/auth/token-scopes/

get_token_scopes

Responses

• 200 — OK
• application/json → ApiTokenScopesResponse
• 422 — Unprocessable Content
• application/json → ValidationError