The SCIM 2.0 compatible API manages PactFlow users and teams.

For general documentation on SCIM support in PactFlow, see the SCIM documentation.

Supported endpoints

  • /scim/ServiceProviderConfig - Specification compliance, authentication schemes, data models
  • /scim/ResourceTypes - An endpoint used to discover the types of resources available
  • /scim/Schemas - Introspect resources and attribute extensions
  • /scim/User - Manage PactFlow users
  • /scim/Groups - Manage PactFlow teams


The SCIM API endpoints require a PactFlow bearer token. It is recommended to use a
PactFlow System Account token for this. The system account must
be assigned the SCIM role to be able to create or update those resources.


SCIM can manage the following resources.:


The /scim/Users endpoint manages PactFlow users. The following SCIM attributes are supported:

SCIM AttributePactFlow User AttributeNotes
iduuidRead only
userNameexternalIdpUsernameThis is the unique user ID that the IDP must send via SAML request
externalIdexternalIdpIdExternal IDP user ID (optional)
name.formattednamename.formatted takes priority over displayName
displayNamenamename.formatted takes priority over displayName
userTypetypeDescription or typeuserType is mapped to the type on the way in, and typeDescription on the way out
email*.value (email*.primary == true or first)emailRequired. The primary email is mapped to the PactFlow email. If no primary email is provided, the first email entry is used
meta.createdcreatedAtread only
meta.lastModifiedupdatedAtread only
role*.display_embedded.roles*.nameread only
role*.type_embedded.roles*.nameread only
groups*.display_embedded.teams*.nameread only

Note that for SAML authentication to work, the userName must be set to the IDP username for the user, otherwise
Pactflow will not be able to match the authenticated user with the provisioned user record in Pactflow.

Teams (as groups)

The /scim/Groups endpoint manages PactFlow teams. The following SCIM attributes are supported:

SCIM AttributePactFlow Team AttributeNotes
iduuidread only
meta.createdcreatedAtread only
meta.lastModifiedupdatedAtread only
members*.display_embedded.members*.nameread only