Skip to main content
ZStack
Settings/User Management APIs

LogInByAccount

LogInByAccount

PUT/zstack/v1/accounts/login

Operation ID

LogInByAccount

Since

0.6

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • accountName
    StringRequired

    The account name.Note: The accountName and accountUuid parameters cannot both be empty.

  • password
    StringRequired

    The password.

  • captchaUuid
    String

    Optional. The verification code UUID.

  • verifyCode
    String

    Optional. The verification code.

  • clientInfo
    Map

    Optional. The client information.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    Error code, null if operation succeeds, non-null if operation fails, see error

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventory
    SessionInventoryRequired

    See inventory

    • uuid
      StringRequired

      The resource UUID.

    • accountUuid
      StringRequired

      The account UUID.

    • userUuid
      StringRequired

      The user UUID.Note: The accountName and accountUuid parameters cannot both be empty.

    • expiredDate
      TimestampRequired

      The expiration date of the session.

    • createDate
      TimestampRequired

      The creation date.