API reference

SCIM provisioning

SCIM 2.0 for your identity provider: people and groups kept in step with your organization.

GET/v1/scim/:orgId/ServiceProviderConfig

SCIM discovery (RFC 7643): PATCH, filters and ETags supported; bulk, sort and password changes not. With the org's SCIM token.

Auth: None.

Path parameters

orgId
Organization id (org_…).

curl 'https://api.cactive.com.au/v1/scim/{orgId}/ServiceProviderConfig'

Send it from this page with your session or a key.

GET/v1/scim/:orgId/ResourceTypes

SCIM discovery: the User and Group resource types.

Auth: None.

Path parameters

orgId
Organization id (org_…).

curl 'https://api.cactive.com.au/v1/scim/{orgId}/ResourceTypes'

Send it from this page with your session or a key.

GET/v1/scim/:orgId/ResourceTypes/:id

SCIM discovery: one resource type.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

curl 'https://api.cactive.com.au/v1/scim/{orgId}/ResourceTypes/{id}'

Send it from this page with your session or a key.

GET/v1/scim/:orgId/Schemas

SCIM discovery: the User and Group schemas this endpoint keeps.

Auth: None.

Path parameters

orgId
Organization id (org_…).

curl 'https://api.cactive.com.au/v1/scim/{orgId}/Schemas'

Send it from this page with your session or a key.

GET/v1/scim/:orgId/Schemas/:id

SCIM discovery: one schema.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

curl 'https://api.cactive.com.au/v1/scim/{orgId}/Schemas/{id}'

Send it from this page with your session or a key.

GET/v1/scim/:orgId/Users

Provisioned users; filter with eq on userName, externalId, id or emails.value, startIndex and count (up to 200).

Auth: None.

Path parameters

orgId
Organization id (org_…).

Query parameters

filterstring
startIndexstring
countstring

curl 'https://api.cactive.com.au/v1/scim/{orgId}/Users'

Send it from this page with your session or a key.

POST/v1/scim/:orgId/Users

Provisions a person: the member with that address is linked, anyone else invited with the token's role. userName is unique.

Auth: None.

Path parameters

orgId
Organization id (org_…).

curl -X POST 'https://api.cactive.com.au/v1/scim/{orgId}/Users'

Send it from this page with your session or a key.

GET/v1/scim/:orgId/Users/:id

A provisioned user, with the groups the identity provider gave them.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

curl 'https://api.cactive.com.au/v1/scim/{orgId}/Users/{id}'

Send it from this page with your session or a key.

PUT/v1/scim/:orgId/Users/:id

Replaces a provisioned user. active: false blocks the member (or withdraws the invite); true unblocks. Owners are never changed.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

curl -X PUT 'https://api.cactive.com.au/v1/scim/{orgId}/Users/{id}'

Send it from this page with your session or a key.

PATCH/v1/scim/:orgId/Users/:id

Changes a provisioned user with SCIM PATCH operations (Okta's and Entra ID's shapes), as PUT applies them.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

curl -X PATCH 'https://api.cactive.com.au/v1/scim/{orgId}/Users/{id}'

Send it from this page with your session or a key.

DELETE/v1/scim/:orgId/Users/:id

Removes the member (restorable in Tenant for 30 days) or withdraws the invite.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

Errors

400You can't do that to yourself.
404Invite not found
409An organization needs at least one other active owner first.

curl -X DELETE 'https://api.cactive.com.au/v1/scim/{orgId}/Users/{id}'

Send it from this page with your session or a key.

Response 204 with no body

GET/v1/scim/:orgId/Groups

Groups the identity provider manages; filter with eq on displayName, externalId or id.

Auth: None.

Path parameters

orgId
Organization id (org_…).

Query parameters

filterstring
startIndexstring
countstring

curl 'https://api.cactive.com.au/v1/scim/{orgId}/Groups'

Send it from this page with your session or a key.

POST/v1/scim/:orgId/Groups

Makes a Tenant group with its members; people who haven't joined are added once they do.

Auth: None.

Path parameters

orgId
Organization id (org_…).

Errors

400Slugs are lowercase letters, digits and single hyphens.
400Unknown role.
404Organization not found
404Not a member of this organization
409A group with this slug exists.

curl -X POST 'https://api.cactive.com.au/v1/scim/{orgId}/Groups'

Send it from this page with your session or a key.

GET/v1/scim/:orgId/Groups/:id

A managed group and its members.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

curl 'https://api.cactive.com.au/v1/scim/{orgId}/Groups/{id}'

Send it from this page with your session or a key.

PUT/v1/scim/:orgId/Groups/:id

Replaces a managed group's name and members.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

curl -X PUT 'https://api.cactive.com.au/v1/scim/{orgId}/Groups/{id}'

Send it from this page with your session or a key.

PATCH/v1/scim/:orgId/Groups/:id

Adds, removes or replaces a managed group's members, or renames it.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

curl -X PATCH 'https://api.cactive.com.au/v1/scim/{orgId}/Groups/{id}'

Send it from this page with your session or a key.

DELETE/v1/scim/:orgId/Groups/:id

Deletes the managed group.

Auth: None.

Path parameters

orgId
Organization id (org_…).
id
A record's id in Customers: its object's prefix and a time-sortable id (acc_…, cnt_…, led_…, opp_…, act_…).

Errors

404Group not found
404Organization not found

curl -X DELETE 'https://api.cactive.com.au/v1/scim/{orgId}/Groups/{id}'

Send it from this page with your session or a key.

Response 204 with no body