Mijn Communities
Help

IAM User endpoint

29-04-2022 12:31 (Bijgewerkt op 20-01-2023)
  • 0 Antwoorden
  • 0 kudos
  • 980 Weergaven

Swagger documentation

The following swagger pages gives an overview of the endpoint:

User endpoint

 

The user endpoint supports the retrieval of users and gives the ability to set the email address as identity for a user. The next methods are supported as part of the users endpoint.

https://api.youserve.nl/iam/v1.0/users

GET

Allows retrieving a single employee based on employeeId for the tenant specified in the request header.

https://api.youserve.nl/iam/v1.0/users(employeeId=12345)

Supports the following parameter as part of the resource path:

  • employeeId - The unique id assigned to an employee. This value is available in the Employees endpoint with the property PersonCode.

Returns a 200 OK when successful

PATCH

Allows to update or set an email address as identity for a specific user based on employeeId  (PersonCode in Employees endpoint) for the tenant specified in the request header.

https://api.youserve.nl/iam/v1.0/users(employeeId=12345)/identity

Supports the following parameter as part of its request body:

  • id- email address of the employee which is to be used for SSO

{
    "id": "user@customer.com"
}

Returns a 204 No content when successful

Visibility of the change in Youforce portal

Please note that updating the identity through this endpoint

  • will update the identity in the Youforce authentication system

  • will NOT show the values in Youforce portal

Our authentication system is not running on the same service as the portal UI. The synchronization is just one way:

  • Changes done in the authentication system direct will not reflect in the Youforce portal UI

  • Changes done in this UI will reflect in the authentication system

Datamapping

Parameters

Description

Example

Data type

employeeId

The unique id assigned to the employee by the HR Core

12345

string

id

User id of the employee used in the Youforce authentication system

HR Core Business: (NL) PING Identiteit (elementnr. 10523564)

c7e230db-2a7f-4ef0-ad1d-9d30e7d94a2f

string

sourceId

Username of the user in the Youforce portal. 

HR Core Business: (NL) Gebruikersnaam (elementnr. 61)

XX123456

string

identityId

UPN/Identity in the customer authentication system that takes care of authentication

HR Core Business: (NL) Identity (elementnr. 7013)

user@customer.com

string