Skip to main content
API Explorer|API Explorer
System Management/User Configuration
GETUser ConfigurationSince 0.6SynchronousAuth Required

Validate Session

Validate Session

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • sessionUuidStringRequired

    Session UUID

Query Parameters

  • systemTagsList

    System tags

  • userTagsList

    User tags

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • validbooleanRequired

    Whether the session is valid

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. This field is null on success. For details, see error

    • codeStringRequired

      The error code number. A globally unique identifier for the error, e.g., SYS.1000, HOST.1001

    • descriptionStringRequired

      A brief description of the error

    • detailsStringRequired

      Detailed information about the error

    • elaborationStringRequired

      Reserved field. Default is null

    • opaqueLinkedHashMapRequired

      Reserved field. Default is null

    • causeErrorCodeRequired

      The root error that caused the current error. This field is null if there is no root cause

Endpoint

GET/zstack/v1/accounts/sessions/{sessionUuid}/valid

/zstack/v1/accounts/sessions/{sessionUuid}/valid

Operation ID

ValidateSession

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/accounts/sessions/{sessionUuid}/valid?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "validSession": true }

Change History

This API has no change history records yet.

View all change history