SCIM registration

Create SCIM Server Detail

Endpoint

POST /auth/realms/master/scim/servers

Request

Headers

Authorization: Bearer <Keyclaok admin REST API Token>

Body parameters

Parameter	Type	Description	Required
baseUrl	String	SCIM url exposed by SCIM Server(SP), that should follow the standard RFC ft-ietf-scim-api: System for Cross-domain Identity Management: Protocol	Required
tokenUrl	String	PlatformIAMService gets token using clientId and clientSecret from SCIM server before making the APIs	Required

Request body example

{
  "baseUrl":"https://xxxxxx.com/passportsvc/api/v1/scim/Users",
  "tokenUrl":"https://xxxxxx.com/passportsvc/api/v1/oauth/token?grant_type=client_credentials&scope=scim",
  "clientId":"GVNAFBRKKQVFZHPGBHMGOECSWQGBFEAG",
  "clientSecret":"GYYQBMMEIKJJMKRNFFKOGFGVWDORERVXRIGFKHYCWCMDGNWKNAEJQMWVVEAUNWSD"
}

Response

Response data example

{
  "id": "d8d36582-eaa3-4739-8d95-10f966f08fb4",
  "baseUrl": "https://xxxxxx.com/passportsvc/api/v1/scim/Users",
  "tokenUrl": "https://xxxxxx.com/passportsvc/api/v1/oauth/token?grant_type=client_credentials&scope=scim",
  "clientId": "GVNAFBRKKQVFZHPGBHMGOECSWQGBFEAG",
  "clientSecret": "GYYQBMMEIKJJMKRNFFKOGFGVWDORERVXRIGFKHYCWCMDGNWKNAEJQMWVVEAUNWSD"
}

Create SCIM Event Listener

Endpoint

POST /auth/realms/master/scim/listeners

Request

Headers

Authorization: Bearer <Keyclaok admin REST API Token>

Body parameters

Parameter	Type	Description	Required
scimServerDetailId	String	Pass the SCIM server detail id.	Required
eventName	String	Pass either "CREATE", "DELETE", "UPDATE"	Required
realmId	String	Enter "iam".	Required

Request body example

{
  "scimServerDetailId":"d6bae675-84ac-4140-939d-aa6d7e92acdd",
  "eventName":"CREATE",
  "realmId":"iam"
}

Response

Response data example

{
  "id": "f84b0b97-0052-40fa-9927-ab4d5d425581",
  "realmId": "iam",
  "scimServerDetailId": "d8d36582-eaa3-4739-8d95-10f966f08fb4",
  "eventName": "CREATE"
}