Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

User

Sign in with API key

Given an organization API key, issue an authorization token for the specified user. The token should then be attached to the Authorization header in subsequent Amigo API calls.

This is an alternative authorization method for users who cannot use the Amigo frontend to login and authenticate.

post/v1/{organization}/user/signin_with_api_key

Path parameters

organizationstring required

Headers

x-api-keystring required

The value of the API key.

The value of the API key.

x-api-key-idstring required

The ID of the API key.

The ID of the API key.

x-user-idstring required

The ID of the user to sign in as.

The ID of the user to sign in as.

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

id_tokenstring required

The ID token that should be attached to the Authorization header for future API calls.

expires_atstring date-time required

The time at which the token expires.