POST
/
hris
/
provisioning-groups
/
{group_id}
/
setup-links
Create provisioning setup link
curl --request POST \
  --url https://api.kombo.dev/v1/hris/provisioning-groups/{group_id}/setup-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "language": "en"
}'
{
  "status": "success",
  "data": {
    "url": "https://connect.kombo.dev/v1/setup?token=GinuMJCpUQ9xdpLmD2ocw8qdiK3qiPCizDCv754EXri2vAX4",
    "expires_at": "2023-10-11T12:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
group_id
string
required

ID of the provisioning group (currently only default is allowed).

Body

application/json

POST /hris/provisioning-groups/:group_id/setup-links Request body

​
language
enum<string> | null
default:en

Language of the UI. Please note that the provisioning setup UI is not translated yet but we're working on it and setting this already will make sure the translations appear once released.

Available options:
en,
de,
fr,
it,
es

Response

POST /hris/provisioning-groups/:group_id/setup-links Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples:
{
  "url": "https://connect.kombo.dev/v1/setup?token=GinuMJCpUQ9xdpLmD2ocw8qdiK3qiPCizDCv754EXri2vAX4",
  "expires_at": "2023-10-11T12:00:00.000Z"
}