projects.authSessions.update

Update AuthSession - Start

Start updating an AuthSession.

post/{workspaceId}/projects/{projectName}/auth-sessions/{authSessionId}/update

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

parametersobject required

The parameters to be passed to the API.

proxystring nullable

Proxy configuration for the job

createAttemptsinteger

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

checkAttemptsinteger

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

saveTraceboolean

Example request

{
  "parameters": {
    "param1": "value1",
    "param2": 42,
    "param3": true
  },
  "proxy": "http://username:password@proxy.example.com:8080",
  "createAttempts": 3,
  "checkAttempts": 3
}

Response

Update AuthSession operation started

status'started' required
operationIdstring required

Changes

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