organizations

GET /organizations/

GET/organizations/

Search organizations with pagination

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

Responses

POST /organizations/

POST/organizations/

Creates a new organization

Request Body

application/json

nameRequired

string·min 1·max 100

defaultRolesRequired

object[]

Responses

GET /organizations/{id}

GET/organizations/{id}

Get organization by id

Path Parameters

idRequired

string

Responses

PUT /organizations/{id}

PUT/organizations/{id}

Update an organization by id

Path Parameters

idRequired

string

Request Body

application/json

nameRequired

string·min 1·max 100

defaultRolesRequired

object[]

Responses

PATCH /organizations/{id}

PATCH/organizations/{id}

Update an organization's branding (name, logo, colors)

Path Parameters

idRequired

string

Request Body

application/json

name

string·min 1·max 100

brandNameRequired

string·min 1·max 200

logoUrlRequired

string·min 1·max 2048

primaryColorRequired

string·min 1

Responses

DELETE /organizations/{id}

DELETE/organizations/{id}

Soft-delete an organization, revoking its members' sessions and the API keys of the credentials it owns

Path Parameters

idRequired

string

Responses

POST /organizations/{id}/users

POST/organizations/{id}/users

Assign a user to an organization

Path Parameters

idRequired

string

Request Body

application/json

userIdRequired

string

Responses

GET /organizations/{id}/oidc-provider

GET/organizations/{id}/oidc-provider

Public OIDC discovery for an organization: issuer, client ID and branding, so admin/user panels can route to the organization's identity provider before authenticating. Excludes the JWKS URI.

Path Parameters

idRequired

string

Responses

PUT /organizations/{id}/oidc-provider

PUT/organizations/{id}/oidc-provider

Set (create or replace) an organization's OIDC identity provider

Path Parameters

idRequired

string

Request Body

application/json

issuerRequired

string

jwksUriRequired

string

audienceRequired

string

clientIdRequired

string

displayName

string

userPanelUrlRequired

string·min 1

Responses

DELETE /organizations/{id}/oidc-provider

DELETE/organizations/{id}/oidc-provider

Remove an organization's OIDC identity provider

Path Parameters

idRequired

string

Responses

GET /organizations/{id}/oidc-provider/config

GET/organizations/{id}/oidc-provider/config

Get an organization's full OIDC provider configuration for the operator view

Path Parameters

idRequired

string

Responses

PUT /organizations/{id}/siwe-settings

PUT/organizations/{id}/siwe-settings

Set an organization's SIWE wallet-login settings. When enabled, the host of the org's OIDC userPanelUrl plus the extra allowed domains become valid SIWE domains for the org's login challenges (authenticated wallet-association challenges accept them regardless).

Path Parameters

idRequired

string

Request Body

application/json

siweLoginEnabledRequired

boolean

siweAllowedDomainsRequired

string[]·max 20

Responses

GET /organizations/{id}/pending-admins

GET/organizations/{id}/pending-admins

List the pending admins seeded for an organization

Path Parameters

idRequired

string

Responses

POST /organizations/{id}/pending-admins

POST/organizations/{id}/pending-admins

Pre-seed an organization's first admin by OIDC sub (consumed on their first login)

Path Parameters

idRequired

string

Request Body

application/json

oidcSubRequired

string·min 1

Responses

DELETE /organizations/{id}/pending-admins/{oidcSub}

DELETE/organizations/{id}/pending-admins/{oidcSub}

Remove a pending admin from an organization

Path Parameters

idRequired

string

oidcSubRequired

string

Responses

GET /organizations/{id}/users/{userId}

GET/organizations/{id}/users/{userId}

Get a single member of the organization

Path Parameters

idRequired

string

userIdRequired

string

Responses

DELETE /organizations/{id}/users/{userId}

DELETE/organizations/{id}/users/{userId}

Remove a member from an organization

Path Parameters

idRequired

string

userIdRequired

string

Responses

POST /organizations/{id}/users/invite

POST/organizations/{id}/users/invite

Pre-authorize a member by OIDC subject (claimed on first login via the org IdP)

Path Parameters

idRequired

string

Request Body

application/json

oidcSubRequired

string·min 1

displayNameRequired

string·min 1·max 100

Responses

PUT /organizations/{id}/users/{userId}/roles

PUT/organizations/{id}/users/{userId}/roles

Set a member's organization-scoped roles

Path Parameters

idRequired

string

userIdRequired

string

Request Body

application/json

rolesRequired

string[]

Responses

GET /organizations/{id}/admins

GET/organizations/{id}/admins

List the admins of an organization

Path Parameters

idRequired

string

Responses

GET /organizations/{id}/audit-logs

GET/organizations/{id}/audit-logs

Paginated, filterable view of the organization's audit log

Path Parameters

idRequired

string

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

userId

string

actionType

string

startDate

string <date-time>

endDate

string <date-time>

Responses

POST /organizations/{id}/sessions/revoke

POST/organizations/{id}/sessions/revoke

Revoke all active sessions of the organization's users

Path Parameters

idRequired

string

Responses

GET /organizations/{id}/roles

GET/organizations/{id}/roles

List an organization's custom roles

Path Parameters

idRequired

string

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

searchQuery

string·max 200

Responses

POST /organizations/{id}/roles

POST/organizations/{id}/roles

Create a custom role scoped to the organization

Path Parameters

idRequired

string

Request Body

application/json

roleNameRequired

string·min 1·max 50

systemPermissionsRequired

string[]

Values

contract_deploymentfull_sequencer_rpc_accessfull_read_accessadmin_readadmin_write

organizationId

string

Responses

GET /organizations/{id}/roles/{roleId}

GET/organizations/{id}/roles/{roleId}

Get one of an organization's custom roles by id

Path Parameters

idRequired

string

roleIdRequired

string·min 1

Responses

PUT /organizations/{id}/roles/{roleId}

PUT/organizations/{id}/roles/{roleId}

Replace an organization role's permissions

Path Parameters

idRequired

string

roleIdRequired

string·min 1

Request Body

application/json

roleNameRequired

string·min 1·max 50

systemPermissionsRequired

string[]

Values

contract_deploymentfull_sequencer_rpc_accessfull_read_accessadmin_readadmin_write

organizationId

string

Responses

DELETE /organizations/{id}/roles/{roleId}

DELETE/organizations/{id}/roles/{roleId}

Delete one of an organization's custom roles

Path Parameters

idRequired

string

roleIdRequired

string·min 1

Responses

GET /organizations/{id}/roles/{roleId}/function-permissions

GET/organizations/{id}/roles/{roleId}/function-permissions

List the function permissions one of the organization's roles grants

Path Parameters

idRequired

string

roleIdRequired

string·min 1

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

Responses

GET /organizations/{id}/m2m-applications

GET/organizations/{id}/m2m-applications

List the M2M credentials visible to the organization: its own credentials plus zone-level credentials the operator assigned to it.

Path Parameters

idRequired

string

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

Responses

POST /organizations/{id}/m2m-applications

POST/organizations/{id}/m2m-applications

Create an M2M credential owned by the organization

Path Parameters

idRequired

string

Request Body

application/json

nameRequired

string·min 1·max 100

description

string

rolesRequired

object[]

Responses

GET /organizations/{id}/m2m-applications/{appId}

GET/organizations/{id}/m2m-applications/{appId}

Get one of the M2M credentials visible to the organization: its own, or a zone-level one assigned to it. Anything else returns 404.

Path Parameters

idRequired

string

appIdRequired

string

Responses

PUT /organizations/{id}/m2m-applications/{appId}

PUT/organizations/{id}/m2m-applications/{appId}

Update an org-owned M2M credential's settings and role/permission selection (within the org-admin ceiling). A credential the org does not own returns 404.

Path Parameters

idRequired

string

appIdRequired

string

Request Body

application/json

nameRequired

string·min 1·max 100

descriptionRequired

string

rolesRequired

object[]

Responses

DELETE /organizations/{id}/m2m-applications/{appId}

DELETE/organizations/{id}/m2m-applications/{appId}

Delete an org-owned M2M credential. Zone-level credentials are operator-delete-only; a credential the org does not own returns 404.

Path Parameters

idRequired

string

appIdRequired

string

Responses

GET /organizations/{id}/m2m-applications/{appId}/api-keys

GET/organizations/{id}/m2m-applications/{appId}/api-keys

List the API keys of an org-owned M2M credential

Path Parameters

idRequired

string

appIdRequired

string

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

Responses

POST /organizations/{id}/m2m-applications/{appId}/api-keys

POST/organizations/{id}/m2m-applications/{appId}/api-keys

Create an API key for an org-owned M2M credential (the full key is returned only once)

Path Parameters

idRequired

string

appIdRequired

string

Request Body

application/json

nameRequired

string·min 1·max 100

expiresAtRequired

unknown

Responses

DELETE /organizations/{id}/m2m-applications/{appId}/api-keys/{keyId}

DELETE/organizations/{id}/m2m-applications/{appId}/api-keys/{keyId}

Revoke an API key of an org-owned M2M credential

Path Parameters

idRequired

string

appIdRequired

string

keyIdRequired

string

Responses

GET /organizations/{id}/m2m-applications/{appId}/ip-whitelist

GET/organizations/{id}/m2m-applications/{appId}/ip-whitelist

List the IP whitelist of an org-owned M2M credential

Path Parameters

idRequired

string

appIdRequired

string

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

Responses

POST /organizations/{id}/m2m-applications/{appId}/ip-whitelist

POST/organizations/{id}/m2m-applications/{appId}/ip-whitelist

Add an IP address to an org-owned M2M credential's whitelist

Path Parameters

idRequired

string

appIdRequired

string

Request Body

application/json

ipAddressRequired

string

description

string

Responses

DELETE /organizations/{id}/m2m-applications/{appId}/ip-whitelist/{entryId}

DELETE/organizations/{id}/m2m-applications/{appId}/ip-whitelist/{entryId}

Remove an IP address from an org-owned M2M credential's whitelist

Path Parameters

idRequired

string

appIdRequired

string

entryIdRequired

string

Responses

GET /organizations/{id}/contracts

GET/organizations/{id}/contracts

List the organization's contracts grouped by template. Returns template groups (with counts) followed by ungrouped contracts.

Path Parameters

idRequired

string

Query Parameters

limit

integer·min 1·max 100·default 10

offset

integer·min 0·max 9007199254740991·default 0

searchQuery

string·max 200

Responses

POST /organizations/{id}/contracts

POST/organizations/{id}/contracts

Path Parameters

idRequired

string

Request Body

application/json

contractAddressRequired

string

abiRequired

string·min 1

nameRequired

string·max 100

descriptionRequired

string

templateId

integer·min -9007199254740991·max 9007199254740991

templateKey

string

Responses

GET /organizations/{id}/contracts/by-template/{templateId}

GET/organizations/{id}/contracts/by-template/{templateId}

List one of the organization's contracts for a specific template with pagination

Path Parameters

idRequired

string

templateIdRequired

integer·min -9007199254740991·max 9007199254740991

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

searchQuery

string·max 200

Responses

GET /organizations/{id}/contracts/{contractAddress}

GET/organizations/{id}/contracts/{contractAddress}

Get one of the organization's contracts by address

Path Parameters

idRequired

string

contractAddressRequired

string

Responses

PUT /organizations/{id}/contracts/{contractAddress}

PUT/organizations/{id}/contracts/{contractAddress}

Replace one of the organization's contracts (full update)

Path Parameters

idRequired

string

contractAddressRequired

string

Request Body

application/json

contractAddressRequired

string

abiRequired

string·min 1

nameRequired

string·max 100

descriptionRequired

string

templateId

integer·min -9007199254740991·max 9007199254740991

templateKey

string

Responses

DELETE /organizations/{id}/contracts/{contractAddress}

DELETE/organizations/{id}/contracts/{contractAddress}

Delete one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

Responses

GET /organizations/{id}/contracts/{contractAddress}/function-permissions

GET/organizations/{id}/contracts/{contractAddress}/function-permissions

List the function-level role permissions on one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

Responses

POST /organizations/{id}/contracts/{contractAddress}/function-permissions

POST/organizations/{id}/contracts/{contractAddress}/function-permissions

Create a function-level role permission on one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

Request Body

application/json

methodSelector

string

accessTypeRequired

string

Values

readwrite

functionSignatureRequired

string

ruleTypeRequired

string

Values

publiccheckRolerestrictArgumentcheckRoleAndRestrictArgumentcheckRoleOrRestrictArgument

roles

object[]

argumentRestrictions

object[]

Responses

PUT /organizations/{id}/contracts/{contractAddress}/function-permissions/{permissionId}

PUT/organizations/{id}/contracts/{contractAddress}/function-permissions/{permissionId}

Replace a function-level role permission on one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

permissionIdRequired

integer·min -9007199254740991·max 9007199254740991

Request Body

application/json

methodSelectorRequired

string

accessTypeRequired

string

Values

readwrite

functionSignatureRequired

string

ruleTypeRequired

string

Values

publiccheckRolerestrictArgumentcheckRoleAndRestrictArgumentcheckRoleOrRestrictArgument

roles

object[]

argumentRestrictions

object[]

Responses

DELETE /organizations/{id}/contracts/{contractAddress}/function-permissions/{permissionId}

DELETE/organizations/{id}/contracts/{contractAddress}/function-permissions/{permissionId}

Delete a function-level role permission on one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

permissionIdRequired

integer·min -9007199254740991·max 9007199254740991

Responses

GET /organizations/{id}/contracts/{contractAddress}/event-permissions

GET/organizations/{id}/contracts/{contractAddress}/event-permissions

List the event-level role permissions on one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

Query Parameters

limit

integer·min 1·max 1000·default 10

offset

integer·min 0·max 9007199254740991·default 0

Responses

POST /organizations/{id}/contracts/{contractAddress}/event-permissions

POST/organizations/{id}/contracts/{contractAddress}/event-permissions

Create an event-level role permission on one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

Request Body

application/json

topic0Constant

string

topic1Constant

string

topic2Constant

string

topic3Constant

string

topic1ConditionType

string

Values

equalTouserAddress

topic2ConditionType

string

Values

equalTouserAddress

topic3ConditionType

string

Values

equalTouserAddress

rolesRequired

object[]

Responses

PUT /organizations/{id}/contracts/{contractAddress}/event-permissions/{eventPermissionId}

PUT/organizations/{id}/contracts/{contractAddress}/event-permissions/{eventPermissionId}

Replace an event-level role permission on one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

eventPermissionIdRequired

string

Request Body

application/json

topic0ConstantRequired

string

topic1ConstantRequired

string

topic2ConstantRequired

string

topic3ConstantRequired

string

topic1ConditionTypeRequired

string

Values

equalTouserAddress

topic2ConditionTypeRequired

string

Values

equalTouserAddress

topic3ConditionTypeRequired

string

Values

equalTouserAddress

rolesRequired

object[]

Responses

DELETE /organizations/{id}/contracts/{contractAddress}/event-permissions/{eventPermissionId}

DELETE/organizations/{id}/contracts/{contractAddress}/event-permissions/{eventPermissionId}

Delete an event-level role permission on one of the organization's contracts

Path Parameters

idRequired

string

contractAddressRequired

string

eventPermissionIdRequired

string

GET /organizations/

Query Parameters

Responses

200Default Response

Show Child AttributesHide Child Attributes

Show Child AttributesHide Child Attributes

401Default Response

Show Child AttributesHide Child Attributes

403Default Response

Show Child AttributesHide Child Attributes

POST /organizations/

Request Body

Show Child AttributesHide Child Attributes

Responses

200Default Response

Show Child AttributesHide Child Attributes

400Default Response

Show Child AttributesHide Child Attributes

403Default Response

Show Child AttributesHide Child Attributes

404Default Response

Show Child AttributesHide Child Attributes

409Default Response

Show Child AttributesHide Child Attributes

GET /organizations/{id}

Path Parameters

Responses

200Default Response

Show Child AttributesHide Child Attributes

401Default Response

Show Child AttributesHide Child Attributes

403Default Response

Show Child AttributesHide Child Attributes

404Default Response

Show Child AttributesHide Child Attributes

PUT /organizations/{id}

Path Parameters

Request Body

Show Child AttributesHide Child Attributes

Responses

200Default Response

Show Child AttributesHide Child Attributes

400Default Response

Show Child AttributesHide Child Attributes

401Default Response

Show Child AttributesHide Child Attributes

403Default Response

Show Child AttributesHide Child Attributes

404Default Response

Show Child AttributesHide Child Attributes

PATCH /organizations/{id}

Path Parameters

Request Body

Responses

200Default Response

Show Child AttributesHide Child Attributes

400Default Response

Show Child AttributesHide Child Attributes

401Default Response

Show Child AttributesHide Child Attributes

403Default Response

Show Child AttributesHide Child Attributes

404Default Response

Show Child AttributesHide Child Attributes

DELETE /organizations/{id}

Path Parameters

Responses

204Default Response

401Default Response

Show Child AttributesHide Child Attributes

403Default Response

Show Child AttributesHide Child Attributes

404Default Response

Show Child AttributesHide Child Attributes

POST /organizations/{id}/users

Path Parameters

Request Body

Responses

200Default Response

Show Child AttributesHide Child Attributes