Skip to main content
POST
/
{workspaceId}
/
projects
/
{projectName}
/
auth-sessions
/
create
CreateOrUpdateAuthSessionStart
import { IntunedClient } from "@intuned/client";

const intunedClient = new IntunedClient({
  workspaceId: "123e4567-e89b-12d3-a456-426614174000",
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await intunedClient.project.authSessions.create.start("my-project", {
    parameters: {
      "username": "john.doe",
      "password": "password",
    },
    proxy: "http://proxy.example.com:8080",
  });

  console.log(result);
}

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

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
workspaceId
string<uuid>
required

Your workspace ID. How to find it?

​
projectName
string
required

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

Body

application/json

Create auth session input schema

​
parameters
object
required

The parameters to be passed to the API.

Example:
{
  "param1": "value1",
  "param2": 42,
  "param3": true
}
​
id
string

The unique identifier for the authentication session

Minimum length: 3
Example:

"auth-session-123"

​
proxy
string<uri> | null

Proxy configuration for the job

Example:

"http://username:password@proxy.example.com:8080"

​
createAttempts
integer
default:3

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

Example:

3

​
checkAttempts
integer
default:3

Number of attempts to check the validity of the auth session before recreating it.

Example:

3

​
saveTrace
boolean
default:true

Response

201 - application/json

Create auth session operation started

​
status
enum<string>
required
Available options:
started
​
operationId
string
required