Sign In

Access

Available without an access token for account/bootstrap flows, including on private instances. The operation still validates its own credentials or cookie when required.

Select one credential form

Send either passwordCredentials or ssoCredentials, not both. The response provides accessToken; retain the HTTP refresh cookie for RefreshToken. Password sign-in may be disabled for ordinary users or require a deployment challenge. An archived user cannot sign in. Do not use a user's password as an automation credential; create a PAT through the account's token settings instead.

Request

SignIn authenticates a user with credentials and returns tokens. On success, returns an access token and sets a refresh token cookie. Supports password-based and SSO authentication methods.

Parameters

No path or query parameters are declared.

Request body

Required

application/json · SignInRequest

Responses

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

{
  "tags": [
    "AuthService"
  ],
  "description": "SignIn authenticates a user with credentials and returns tokens.\n On success, returns an access token and sets a refresh token cookie.\n Supports password-based and SSO authentication methods.",
  "operationId": "AuthService_SignIn",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SignInRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SignInResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}