Skip to main content
ZStack
Settings/User Management APIs

GetTwoFactorAuthenticationSecret

GetTwoFactorAuthenticationSecret

GET/zstack/v1/twofactorauthentication/secret

Operation ID

GetTwoFactorAuthenticationSecret

Since

2.6.0

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

Query Parameters

  • name
    StringRequired

    The resource name.

  • password
    StringRequired

    The password.

  • type
    StringRequired

    The resource type.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

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
    TwoFactorAuthenticationSecretInventoryRequired

    See inventory

    • uuid
      StringRequired

      The resource UUID.

    • secret
      StringRequired

      The two-factor authentication secret.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • userUuid
      StringRequired

      The user UUID.

    • userType
      StringRequired

      The user type.

    • status
      TwoFactorAuthenticationSecretStatusRequired

      See status

      • name
        StringRequired

        The resource name.

      • ordinal
        intRequired

        The sequence number.