234 actions

Action

Description

List Agent Blueprints

List agent blueprints

List Agent Instances

List agent instances

List Agent Instance Sessions

List agent instance sessions

Get An Agent Blueprint

Get an agent blueprint

Get An Agent Instance

Get an agent instance

Get An Agent Registration

Get an agent registration

Get An Agent Instance Session

Get an agent instance session

Create An Agent Blueprint

Create an agent blueprint

Mint An Agent Token

Mint an agent token

Update An Agent Blueprint

Update an agent blueprint

Delete An Agent Blueprint

Delete an agent blueprint

Delete An Agent Instance

Delete an agent instance

Link A Claim Attempt To An External User

Link a claim attempt to an external user

Revoke An Agent Instance Session

Revoke an agent instance session

Validate An Agent Token

Validate an agent token

Validate An Agent Credential

Validate an agent credential

List API Keys For An Organization

List API keys for an organization

Create An API Key For An Organization

Create an API key for an organization

Delete An API Key

Delete an API key

Expire An API Key

Expire an API key

Validate API Key

Validate API key

List Audit Log Actions

Get a list of all Audit Log actions in the current environment.

Get Audit Log Export

Get an Audit Log Export. The URL will expire after 10 minutes. If the export is needed again at a later time, refetching...

List Audit Log Schemas

Get a list of all schemas for the Audit Logs action identified by `:name`.

Get Audit Log Retention

Get the configured event retention period for the given Organization.

Create Audit Log Event

Create an Audit Log Event. This API supports idempotency which guarantees that performing the same operation multiple ti...

Create Audit Log Export

Create an Audit Log Export. Exports are scoped to a single organization within a specified date range.

Create Audit Log Schema

Creates a new Audit Log schema used to validate the payload of incoming Audit Log Events. If the `action` does not exist...

Set Audit Log Retention

Set the event retention period for the given Organization.

List CORS Origins

List CORS origins

List Redirect URIs

List redirect URIs

Get JWT Template

Get JWT template

Create A CORS Origin

Create a CORS origin

Create A Redirect URI

Create a redirect URI

Update JWT Template

Update JWT template

Delete A Redirect URI

Delete a redirect URI

List Role Assignments For A Group

List role assignments for a group

List Membership Resource Permissions

List effective permissions for an organization membership on a resource

List Resources For Organization Membership

List resources for organization membership

List Role Assignments

List role assignments

List Permissions

List permissions

List Organization Memberships For Resource

List organization memberships for resource

List Memberships For A Resource By External ID

List memberships for a resource by external ID

List Resource Permissions By Ext ID

List effective permissions for an organization membership on a resource by external ID

List Role Assignments For A Resource

List role assignments for a resource

List Role Assignments For A Resource By External ID

List role assignments for a resource by external ID

List Resources

List resources

Get A Group Role Assignment

Get a group role assignment

Get A Custom Role

Get a custom role

Get A Permission

Get a permission

Get A Resource

Get a resource

Get A Resource By External ID

Get a resource by external ID

Get An Environment Role

Get an environment role

Assign A Role To A Group

Assign a role to a group

Assign A Role

Assign a role

Create A Custom Role

Create a custom role

Create A Permission

Create a permission

Create An Authorization Resource

Create an authorization resource

Create An Environment Role

Create an environment role

Add A Permission To A Custom Role

Add a permission to a custom role

Add A Permission To An Environment Role

Add a permission to an environment role

Update A Custom Role

Update a custom role

Update A Permission

Update a permission

Update A Resource

Update a resource

Update A Resource By External ID

Update a resource by external ID

Update An Environment Role

Update an environment role

Replace All Role Assignments For A Group

Replace all role assignments for a group

Set Permissions For A Custom Role

Set permissions for a custom role

Set Permissions For An Environment Role

Set permissions for an environment role

Check Authorization

Check authorization

Remove A Group Role Assignment

Remove a group role assignment

Remove Group Role Assignments By Criteria

Remove group role assignments by criteria

Remove A Role Assignment By ID

Remove a role assignment by ID

Remove A Role Assignment

Remove a role assignment

Delete A Custom Role

Delete a custom role

Remove A Permission From A Custom Role

Remove a permission from a custom role

Delete A Permission

Delete a permission

Delete An Authorization Resource

Delete an authorization resource

Delete An Authorization Resource By External ID

Delete an authorization resource by external ID

List Client Secrets For A Connect Application

List Client Secrets for a Connect Application

List Connect Applications

Get A Connect Application

Get a Connect Application

Create A New Client Secret For A Connect Application

Create a new client secret for a Connect Application

Create A Connect Application

Create a Connect Application

Update A Connect Application

Update a Connect Application

Delete A Connect Application

Delete a Connect Application

List Connections

Get a list of all of your existing connections matching the criteria specified.

Get Connection

Get the details of an existing connection.

Create Connection

Creates a new connection for an organization. Provide `saml_options` or `oidc_options` to configure the identity provide...

Update Connection

Updates an existing connection. Only the provided fields are changed; fields that accept `null` are reset to their defau...

Delete Connection

Permanently deletes an existing connection. It cannot be undone.

List Data Integrations

List data integrations

Create A Data Integration

Create a data integration

List Providers For An Organization

List providers for an organization

List Providers For A User

List providers for a user

Get A Data Integration

Get a data integration

Get An Organization-owned Data Integration

Get an organization-owned data integration

Get An Organization Connected Account

Get an organization connected account

Get A Connected Account

Get a connected account

Create Another API Key Connected Account

Create another API key connected account

Create Another Client Credentials Connected Account

Create another client credentials connected account

Vend Credentials For A Connected Account

Vend credentials for a connected account

Get An Access Token For A Connected Account

Get an access token for a connected account

Import An Organization Connected Account

Import an organization connected account

Import A Connected Account

Import a connected account

Update A Data Integration

Update a data integration

Update An Organization Connected Account

Update an organization connected account

Update A Connected Account

Update a connected account

Upsert An API Key For A Connected Account

Upsert an API key for a connected account

Upsert Client Credentials For A Connected Account

Upsert client credentials for a connected account

Update An Organization-owned Data Integration

Update an organization-owned data integration

Get Authorization URL

Get authorization URL

Delete A Data Integration

Delete a data integration

Delete An Organization-owned Data Integration

Delete an organization-owned data integration

Delete An Organization Connected Account

Delete an organization connected account

Delete A Connected Account

Delete a connected account

List Directories

Get a list of all of your existing directories matching the criteria specified.

Get Directory

Get the details of an existing directory.

Sync Directory

Request an asynchronous sync from the directory provider. Currently supports Google Workspace directories in linked or v...

Delete Directory

Permanently deletes an existing directory. It cannot be undone.

List Directory Groups

Get a list of all of existing directory groups matching the criteria specified.

Get Directory Group

Get the details of an existing Directory Group.

List Directory Users

Get a list of all of existing Directory Users matching the criteria specified.

Get Directory User

Get the details of an existing Directory User.

Get An Email Verification Code

Get an email verification code

Verify Email

Verify email

Send Verification Email

Send verification email

List Events

List events for the current environment.

List Feature Flags

List feature flags

List Enabled Feature Flags For An Organization

List enabled feature flags for an organization

List Enabled Feature Flags For A User

List enabled feature flags for a user

Get A Feature Flag

Get a feature flag

Add A Feature Flag Target

Add a feature flag target

Remove A Feature Flag Target

Remove a feature flag target

Disable A Feature Flag

Disable a feature flag

Enable A Feature Flag

Enable a feature flag

List Group Members

List Group members

List Membership Groups

List groups

List Organization Groups

List groups

Get A Group

Get a group

Add A Member To A Group

Add a member to a Group

Create A Group

Create a group

Update A Group

Update a group

Remove A Member From A Group

Remove a member from a Group

Delete A Group

Delete a group

List Invitations

Get a list of all of invitations matching the criteria specified.

Get Invitation

Get the details of an existing invitation.

Get Invitation By Token

Retrieve an existing invitation using the token.

Send Invitation

Sends an invitation email to the recipient.

Accept Invitation

Accepts an invitation and, if linked to an organization, activates the user's membership in that organization.

Resend Invitation

Resends an invitation email to the recipient. The invitation must be in a pending state.

Revoke Invitation

Revokes an existing invitation.

List IT Contacts

List IT contacts

Create An IT Contact

Create an IT contact

Delete An IT Contact

Delete an IT contact

Invite An IT Contact

Invite an IT contact

Revoke An IT Contact's Invitation

Revoke an IT contact's invitation

List Authentication Factors

List authentication factors

Get Factor

Enroll An Authentication Factor

Enroll an authentication factor

Challenge Factor

Delete Factor

Enroll Factor

Verify Challenge

Get Organization Domain

Get the details of an existing organization domain.

Create Organization Domain

Creates a new Organization Domain.

Verify Organization Domain

Initiates verification process for an Organization Domain.

Delete Organization Domain

Permanently deletes an organization domain. It cannot be undone.

List Organization Memberships

Get a list of all organization memberships matching the criteria specified. At least one of `user_id` or \`organization\_i...

Get Organization Membership

Get the details of an existing organization membership.

Create Organization Membership

Creates a new `active` organization membership for the given organization and user. Calling this API with an organizatio...

Update Organization Membership

Update the details of an existing organization membership.

Deactivate Organization Membership

Deactivates an `active` organization membership. Emits an \[organization\_membership.updated]\([https://workos.com/events/or](https://workos.com/events/or)...

Reactivate Organization Membership

Reactivates an `inactive` organization membership, retaining the pre-existing role(s). Emits an \[organization\_membership...

Delete Organization Membership

Permanently deletes an existing organization membership. It cannot be undone.

List Organizations

Get a list of all of your existing organizations matching the criteria specified.

Get Organization

Get the details of an existing organization.

Get Organization By External ID

Get the details of an existing organization by an \[external identifier]\([https://workos.com/authkit/metadata/external-ide](https://workos.com/authkit/metadata/external-ide)...

Get Organization Audit Log Configuration

Get the unified view of audit log trail and stream configuration for an organization.

Create Organization

Creates a new organization in the current environment.

Update Organization

Updates an organization in the current environment.

Delete Organization

Permanently deletes an organization in the current environment. It cannot be undone.

Get A Password Reset Token

Get a password reset token

Create A Password Reset Token

Create a password reset token

Reset The Password

Reset the password

Get A Team

Get a team

Create A Team

Create a team

Create Portal Link

Generate a Portal Link scoped to an Organization.

Create An Attempt

Create an attempt

Add An Entry To A Radar List

Add an entry to a Radar list

Update A Radar Attempt

Update a Radar attempt

Remove An Entry From A Radar List

Remove an entry from a Radar list

List Roles

List all environment roles in priority order.

List Organization Roles

Get a list of all roles that apply to an organization. This includes both environment roles and custom roles, returned i...

List IdP Signing Certificates

List IdP signing certificates

List SP Encryption Certificates

List SP encryption certificates

Get The SP Signing Certificate

Get the SP signing certificate

Create An IdP Signing Certificate

Create an IdP signing certificate

Create An SP Encryption Certificate

Create an SP encryption certificate

Create An SP Signing Certificate

Create an SP signing certificate

Delete An IdP Signing Certificate

Delete an IdP signing certificate

Delete An SP Encryption Certificate

Delete an SP encryption certificate

Delete The SP Signing Certificate

Delete the SP signing certificate

Revoke Session

List Users

Get a list of all of your existing users matching the criteria specified.

Get User

Get the details of an existing user.

List User Sessions

Get a list of all active sessions for a specific user.

Get User Identities

Get a list of identities associated with the user. A user can have multiple associated identities after going through \[i...

Get User By External ID

Get the details of an existing user by an \[external identifier]\([https://workos.com/authkit/metadata/external-identifiers](https://workos.com/authkit/metadata/external-identifiers)...

Create User

Create a new user in the current environment.

Update User

Updates properties of a user. The omitted properties will be left unchanged.

Delete User

Permanently deletes a user in the current environment. It cannot be undone.

List Object Versions

List object versions

List Objects

List objects

Read An Object By ID

Read an object by ID

Read An Object By Name

Read an object by name

Describe An Object

Describe an object

Create An Object

Create an object

Create A Data Key

Create a data key

Update An Object

Update an object

Decrypt A Data Key

Decrypt a data key

Delete An Object

Delete an object

Re-encrypt A Data Key

Re-encrypt a data key

List Waitlist Entries

List waitlist entries

List Waitlists

List waitlists

Get A Waitlist

Get a waitlist

Create A Waitlist Entry

Create a waitlist entry

Approve A Waitlist Entry

Approve a waitlist entry

Delete A Waitlist Entry

Delete a waitlist entry

Deny A Waitlist Entry

Deny a waitlist entry

List Webhook Endpoints

Create A Webhook Endpoint

Create a Webhook Endpoint

Update A Webhook Endpoint

Update a Webhook Endpoint

Delete A Webhook Endpoint

Delete a Webhook Endpoint