INintunedhq
projects.authSessions.validate

Validate AuthSession - Start

Start AuthSession validation.

post/{workspaceId}/projects/{projectName}/auth-sessions/{authSessionId}/validate/start

Request

  • Base URL
    https://app.intuned.io/api/v1/workspace
  • Auth
    API key in header x-api-key

Path parameters

workspaceIdstring uuid required

Your workspace ID. How to find it?

projectNamestring required

The name you assigned when creating the Project.

authSessionIdstring required

Authentication session ID. You can obtain it from the AuthSessions tab in your project details.

Request body

autoRecreateboolean

If true, the AuthSession will be automatically recreated if the check fails.

checkAttemptsinteger

Number of attempts to check the validity of the AuthSession before recreating it.

createAttemptsinteger

Number of attempts to create a new AuthSession if the current one is invalid or expired.

proxystring uri nullable

Proxy URL to be used for the API call. This is optional and can be used to route the API call through a proxy server. Use "intuned://auto" to let the platform pick a proxy for this project.

requestTimeoutinteger

Timeout for the API request in seconds. Default is 10 minutes (600 seconds).

Example request

{
  "autoRecreate": true,
  "checkAttempts": 3,
  "createAttempts": 3,
  "proxy": "http://username:password@domain:port",
  "requestTimeout": 600
}

Response

Validate AuthSession operation started

status'pending' required
operationIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.