Auth Sessions APIs
Create Auth Session - Start
Auth Sessions APIs
Create Auth Session - Start
Starts creation process of an authentication session for a project with the authentication session creation setting enabled.
POST
/
{workspaceId}
/
projects
/
{projectName}
/
auth-sessions
/
create
Authorizations
x-api-key
string
headerrequiredAPI Key used to authenticate your requests. How to create one.
Path Parameters
workspaceId
string
requiredYour workspace ID. How to find it?
projectName
string
requiredYour project name. It is the name you provide when creating a project.
Body
application/json
Auth session create request
id
string
Auth session id, can contain letters, numbers and hyphens, default is a random uuid
parameters
Auth session parameters
proxy
string
Proxy URL following this format http://username:password@domain:port
Response
201 - application/json
operationId
string
requiredOperation ID for the auth session creation. This is used in the resume and result operations.
status
enum<string>
requiredAvailable options:
started