Identity Change Event

Overview

This page will host the documentation for the identity change-related events (Create, Update, Delete) that are publicly available on public.concur.user.profile.identity topic in the Event Subscription Service (ESS). Subscribers can subscribe to these events by following the steps described on the Event Subscription Service v4 page.

Limitations

Access to this documentation does not provide access to the subscription.

Scope Usage

Which scopes are required to interact with this topic.

Name Description
identity.user.event.read Status of an identity create, change, delete.

Events

This section lists the publicly available events.

Identity Create Event

The IdentityProfileCreated eventType is intended to be published when a new identity has been created. Based on business needs, the event could trigger an application to make API calls to SAP Concur services or start a process in a third-party application.

Identity Update Event

The IdentityProfileUpdated eventType is intended to be published when an existing identity has been updated. Subscribers of the event are able to leverage the data in the message to know what attributes of a user has updated. The value of the attribute will not be shared within the event. Based on business needs, the event could trigger an application to make API calls to SAP Concur services or start a process in a third-party application.

Identity Delete Event

The IdentityProfileDeleted eventType is intended to be published when a new identity has been deleted. Based on business needs, the event could trigger an application to make API calls to SAP Concur services or start a process in a third-party application.

Schema

Schema for Event

Name Type Format Description
id UUID RFC 4122 EventId, unique identifier of this event.
correlationId UUID RFC 4122 Unique identifier used for logging/traceability.
eventType string string Supported values: IdentityProfileCreated, IdentityProfileUpdated, IdentityProfileDeleted.
topic string string Public topic public.concur.user.profile.identity that the event belongs to.
timeStamp timeStamp RFC 3339 Current system time (UTC) when the event notification is issued.
facts map Facts Schema Required key-value pairs providing the content of the event.
facts.originator string string Source application publishing the event.
facts.companyId string RFC 4122 Organization associated with userId.
facts.userId string RFC 4122 Unique identifier of this user object.
facts.attributes list string Modified fields during an IdentityProfileUpdated event, otherwise null.

Create Sample Events

{
    "id": "created-fc48f42d-724e-46e5-a35a-552d7b70996a-12345",
    "correlationId": "1a93bd06-90ec-4b15-bbe4-8ba135d7864d",
    "eventType": "IdentityProfileCreated",
    "topic": "public.concur.profile.identity",
    "timeStamp": "2020-11-16T18:08:51.309Z",
    "subtopic": "fc48f42d-724e-46e5-a35a-552d7b70996a",
    "facts": {
      "originator": "com.concur.profile",
      "companyId": "9d355ee4-70e3-4d85-85af-50f413f21cb6",
      "userId": "fc48f42d-724e-46e5-a35a-552d7b70996a",
      "userHref": "https://us.api.concursolutions.com/profile/identity/v4/Users/fc48f42d-724e-46e5-a35a-552d7b70996a",
      "attributes" : null
 }

Update Sample Events

{
    "id": "updated-fc48f42d-724e-46e5-a35a-552d7b70996a-24681",
    "correlationId": "1a93bd06-90ec-4b15-bbe4-8ba135d7864d",
    "eventType": "IdentityProfileUpdated",
    "topic": "public.concur.profile.identity",
    "timeStamp": "2020-12-16T18:08:51.309Z",
    "subtopic": "fc48f42d-724e-46e5-a35a-552d7b70996a",
    "facts": {
      "originator": "com.concur.profile",
      "companyId": "9d355ee4-70e3-4d85-85af-50f413f21cb6",
      "userId": "fc48f42d-724e-46e5-a35a-552d7b70996a",
      "userHref": "https://us.api.concursolutions.com/profile/identity/v4/Users/fc48f42d-724e-46e5-a35a-552d7b70996a",
      "attributes" : [
        "active",
        "nickName",
        "name.familyName",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.startDate",
        ...
      ]
    }
}

Delete Sample Events

{
    "id": "deleted-fc48f42d-724e-46e5-a35a-552d7b70996a-14812",
    "correlationId": "1a93bd06-90ec-4b15-bbe4-8ba135d7864d",
    "eventType": "IdentityProfileDeleted",
    "topic": "public.concur.profile.identity",
    "timeStamp": "2020-13-16T18:08:51.309Z",
    "subtopic": "fc48f42d-724e-46e5-a35a-552d7b70996a",
    "facts": {
      "originator": "com.concur.profile",
      "companyId": "9d355ee4-70e3-4d85-85af-50f413f21cb6",
      "userId": "fc48f42d-724e-46e5-a35a-552d7b70996a",
      "userHref": "https://us.api.concursolutions.com/profile/identity/v4/Users/fc48f42d-724e-46e5-a35a-552d7b70996a",
      "attributes" : null
    }
}

On this page