POST
/
{workspaceId}
/
projects
/
{projectName}
/
auth-sessions
/
{authSessionId}
/
update
import { IntunedClient } from "@intuned/client";

const intunedClient = new IntunedClient({
  apiKey: "<YOUR_API_KEY_HERE>",
  workspaceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
});

async function run() {
  const result = await intunedClient.project.authSessions.update.start("my-project", "<value>", {
    id: "my-auth-session",
    parameters: {
      "key": "<value>",
    },
  });
  
  // Handle the result
  console.log(result)
}

run();
{
  "operationId": "aabbccddeeffggh",
  "status": "started"
}

Authorizations

x-api-key
string
header
required

API Key used to authenticate your requests. How to create one.

Path Parameters

workspaceId
string
required

Your workspace ID. How to find it?

projectName
string
required

Your project name. It is the name you provide when creating a project.

authSessionId
string
required

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

Body

application/json
update authentication session request

Auth session create request

id
string
required

Auth session id.

parameters

Auth session parameters

proxy
string

Proxy URL following this format http://username:password@domain:port

Response

201
application/json
Successfully started creation
operationId
string
required

Operation ID for the auth session creation. This is used in the resume and result operations.

status
enum<string>
required
Available options:
started