Create SCIM Token

Time	Status	User Agent
Retrieving recent requests…

This API allows you to generate a SCIM provisioning token for one or more organizations. Each token is returned once in the response. Store it immediately; the token can't be retrieved again. To generate a new token for an organization that already has an active token, first revoke the existing token.

Note: This API processes each organization independently. If token generation fails for some organizations, it still returns HTTP 200. Check the failed array in the response for details on which organizations failed and why.

Example request

curl --location 'https://eu.api.capillarytech.com/launchpad/api/v1/orgs/scim/tokens' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6WyIyOTIyMjkiXSwib3JnSUQiOjAsImV4cCI6MTc3NzA5NDQwNCwiaWF0IjoxNzc3MDA4MDA0LCJpc3MiOiJjYXBpbGxhcnl0ZWNoLmNvbSIsImF1ZCI6ImNhcGlsbGFyeSxpbnRvdWNoLGFyeWEscmVvbixhcHBzIiwic291cmNlIjoiV0VCQVBQIiwicmVmZXJlbmNlSUQiOiI1MDc3OTk5NyJ9.2k37ovR4kLNOXXEYZT9XjY-J5v72ObaCvl4lPDbQlMg' \
--header 'X-CAP-API-AUTH-ORG-ID: 50947' \
--data '[
    {
      "org_name": "Loyalty Lane"
    }
  ]'

Prerequisites

A valid Bearer token for the organization.

Header information

Field	Type	Required	Description
`Content-Type`	string	Required	Must be `application/json`.
`Authorization`	string	Required	Bearer token for an Intouch admin user with org owner access. This is the `CT` session cookie from your active Intouch session.
`X-CAP-API-AUTH-ORG-ID`	integer	Required	Org ID of the admin user making the request.

Body parameters

Field	Type	Required	Description
`org_name`	string	Required	Name of the organization to generate a SCIM token for. Must exactly match the organization name in Capillary. Case-sensitive.

Example response

{
    "success": true,
    "metadata": {
        "status": 200,
        "errorCode": "",
        "message": "",
        "error": []
    },
    "result": {
        "successful": [
            {
                "org_id": 50947,
                "org_name": "Loyalty Lane",
                "token": "7351f986b6c1ce4856883b5b1ca12b277eb3c483b5168613664505170eabac1d"
            }
        ],
        "failed": []
    }
}

Response parameters

Field	Type	Description
`success`	boolean	Indicates whether the request was processed. `true` even when some organizations fail — check `result.failed` for per-org errors.
`metadata.status`	integer	HTTP status code of the response.
`result.successful`	array	Organizations for which a token was successfully generated.
`result.successful[].org_id`	integer	Unique identifier of the organization.
`result.successful[].org_name`	string	Name of the organization.
`result.successful[].token`	string	Generated SCIM Bearer token. A 64-character hex string. Store this immediately — the token is returned only once and can't be retrieved again.
`result.failed`	array	Organizations for which token generation failed. Empty if all organizations succeeded.
`result.failed[].org_name`	string	Name of the organization that failed.
`result.failed[].error_code`	string	Numeric code identifying the failure reason. See Error & warning codes.
`result.failed[].error_name`	string	Symbolic name for the error.
`result.failed[].details`	string	Human-readable description of why the token generation failed.

Error codes

Code	Error number	Description
`ORG_NOT_FOUND`	2001	The organization name was not found or is inactive. Check that `org_name` exactly matches the organization name in Capillary.
`ACTIVE_TOKEN_EXISTS`	2002	An active SCIM token already exists for this organization. Revoke the existing token before generating a new one.
`DATABASE_ERROR`	2005	A database error occurred while creating the token. Retry the request. HTTP 200 with failed entry.