Organizations
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
PATCH | |
DELETE | |
GET | |
POST | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
GET | |
DELETE | |
PATCH | |
GET | |
POST | |
DELETE |
Update domains
Required API key scopes
organization:writePath parameters
- idstring
Request parameters
- domainstring
- jit_provisioning_enabledboolean
- sso_enforcementstring
- saml_entity_idstringnull
- saml_acs_urlstringnull
- saml_x509_certstringnull
- scim_enabledboolean
- id_jag_issuer_urlstringnull
- id_jag_jwks_urlstringnull
- id_jag_allowed_clientsarray
- identity_provider_configstringnull
Response
Example request
PATCH /api /organizations /:organization_id /domains /:idExample response
Status 200
Delete domains
Required API key scopes
organization:writePath parameters
- idstring
Example request
DELETE /api /organizations /:organization_id /domains /:idExample response
Status 204 No response body
Retrieve domains scim logs
Path parameters
- idstring
Example request
GET /api /organizations /:organization_id /domains /:id /scim /logsExample response
Status 200 No response body
Create domains scim token
Regenerate SCIM bearer token.
Path parameters
- idstring
Request parameters
- domainstring
- jit_provisioning_enabledboolean
- sso_enforcementstring
- saml_entity_idstringnull
- saml_acs_urlstringnull
- saml_x509_certstringnull
- scim_enabledboolean
- id_jag_issuer_urlstringnull
- id_jag_jwks_urlstringnull
- id_jag_allowed_clientsarray
- identity_provider_configstringnull
Example request
POST /api /organizations /:organization_id /domains /:id /scim /tokenExample response
Status 200 No response body
Create domains verify
Path parameters
- idstring
Request parameters
- domainstring
- jit_provisioning_enabledboolean
- sso_enforcementstring
- saml_entity_idstringnull
- saml_acs_urlstringnull
- saml_x509_certstringnull
- scim_enabledboolean
- id_jag_issuer_urlstringnull
- id_jag_jwks_urlstringnull
- id_jag_allowed_clientsarray
- identity_provider_configstringnull
Example request
POST /api /organizations /:organization_id /domains /:id /verifyExample response
Status 200 No response body
List all identity provider configs
Required API key scopes
organization:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /identity_provider_configsExample response
Status 200
Create identity provider configs
Required API key scopes
organization:writeRequest parameters
- namestring
- saml_entity_idstringnull
- saml_acs_urlstringnull
- saml_x509_certstringnull
- scim_enabledboolean
- id_jag_issuer_urlstringnull
- id_jag_jwks_urlstringnull
- id_jag_allowed_clientsarray
Response
Example request
POST /api /organizations /:organization_id /identity_provider_configsExample response
Status 201
Retrieve identity provider configs
Required API key scopes
organization:readPath parameters
- idstring
Response
Example request
GET /api /organizations /:organization_id /identity_provider_configs /:idExample response
Status 200
Update identity provider configs
Required API key scopes
organization:writePath parameters
- idstring
Request parameters
- namestring
- saml_entity_idstringnull
- saml_acs_urlstringnull
- saml_x509_certstringnull
- scim_enabledboolean
- id_jag_issuer_urlstringnull
- id_jag_jwks_urlstringnull
- id_jag_allowed_clientsarray
Response
Example request
PATCH /api /organizations /:organization_id /identity_provider_configs /:idExample response
Status 200
Delete identity provider configs
Required API key scopes
organization:writePath parameters
- idstring
Example request
DELETE /api /organizations /:organization_id /identity_provider_configs /:idExample response
Status 204 No response body
Create identity provider configs scim token
Regenerate the SCIM bearer token for this IdP config.
Path parameters
- idstring
Response
Example request
POST /api /organizations /:organization_id /identity_provider_configs /:id /scim /tokenExample response
Status 200
List all org organizations integrations
ViewSet for organization-level integrations.
Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
Required API key scopes
organization_integration:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /integrationsExample response
Status 200
Retrieve org organizations integrations
ViewSet for organization-level integrations.
Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
Required API key scopes
organization_integration:readPath parameters
- idstring
Response
Example request
GET /api /organizations /:organization_id /integrations /:idExample response
Status 200
Delete org organization integrations
ViewSet for organization-level integrations.
Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
Required API key scopes
organization_integration:writePath parameters
- idstring
Example request
DELETE /api /organizations /:organization_id /integrations /:idExample response
Status 204 No response body
Update integrations environment mapping
ViewSet for organization-level integrations.
Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
Path parameters
- idstring
Request parameters
Response
Example request
PATCH /api /organizations /:organization_id /integrations /:id /environment-mappingExample response
Status 200
List all invites
Required API key scopes
organization_member:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /invitesExample response
Status 200
Create invites
Required API key scopes
organization_member:writeRequest parameters
- target_emailstring
- first_namestring
- level
- messagestringnull
- private_project_access
- send_emailbooleanDefault:
true - combine_pending_invitesbooleanDefault:
false
Response
Example request
POST /api /organizations /:organization_id /invitesExample response
Status 201
Delete invites
Required API key scopes
organization_member:writePath parameters
- idstring
Example request
DELETE /api /organizations /:organization_id /invites /:id