Example objects and operations

Example objects and operations for the 10Duke Identity Management Graph API.

Login

Logs in the user and establishes an authenticated session.

POST /graph?operation=Login

Parameters:

Parameter In Type Required
userName: The login email address or user name query or form string true
password: The password query or form string true

Profile

Generic operations: POST, GET, PUT, DELETE

Register a user

Creates and initializes a new user in the system.

POST /graph?operation=RegisterUser

Parameters:

Parameter In Type Required
body: The Profile object specifying the user to create body Profile true

Change login email

Changes the user’s email address that is used as the login name.

POST /graph?operation=ChangeLoginEmail

Parameters:

Parameter In Type Required
profileId: The id of the profile for which the login email is changed query or form UUID true
recoveryEmailId: query or form    

Change contact info email

Changes the user’s email address that is used as the contact email that can be displayed to other users.

POST /graph?operation=ChangeContactInfoEmail

Parameters:

Parameter In Type Required
profileId: The id of the profile for which the contact info email is changed query or form UUID true
recoveryEmailId query or form    

Add a user to a group or organization

Adds a user to a ProfileGroup. Adding a user to an organization is done by adding the user to a ProfileGroup that represents the organization members.

POST /graph?operation=AddToProfileGroups

Parameters:

Parameter In Type Required
profileId: The id of the profile to be added in the group query or form UUID true
profileGroupId: The id of the group to which the user is added query or form UUID true
allowAlreadyAdded: Controls how the operation behaves if the user is already in the group. If true, the operation doesn’t give an error response in this case. query or form boolean false

Remove a user from a group or organization

Removes a user from a ProfileGroup. Removing a user from an organization is done by removing the user from a ProfileGroup that represents the organization members.

POST /graph?operation=RemoveFromProfileGroups

Parameters:

Parameter In Type Required
profileId: The id of the profile to be removed from the group query or form UUID true
profileGroupId: The id of the group from which the user is removed query or form UUID true
allowAlreadyRemoved: Controls how the operation behaves if the user is not in the group. If true, the operation doesn’t give an error response in this case. query or form boolean false

Add a user to an organization role

Adds a user to an OrganizationRole, that is, to a role that is used for granting permissions in the scope of an organization.

POST /graph?operation=AddToRole

Parameters:

Parameter In Type Required
profileId: The id of the profile to be added in the role query or form UUID true
organizationId: The id of the organization scoping the role and the attached permissions query or form UUID true
organizationRoleId: The id of the role in which the user is added query or form UUID true

Related objects:

  • ~ManyToOne/Person

  • ~OneToMany/ContactInformation

  • ~Membership/ProfileGroup

  • ~OneToMany/Property:ProfileProperty

  • ~ManyToMany/Role

  • ~ManyToMany/OrganizationRole

  • ~ManyToMany/ConsumerRole

Organization

Generic operations: POST, GET, PUT, DELETE

Specific operations:

GET/graph/Organization[@id='ID_GOES_HERE']

GET /graph/Organization[@name='NAME_GOES_HERE']

Related objects:

  • ~OneToMany/OrganizationContactInformation

  • ~OneToMany/OrganizationRole

  • ~OneToMany/ProfileGroup

  • ~OneToMany/VatNumber

  • ~ServicePartnership/Organization

EmailAddress

Generic operations: POST, GET, PUT, DELETE

Specific operations:

POST /graph

operation=ChangeContactInfoEmail&profileId=[PROFILE_ID]&recoveryEmailId=[EMAIL_ID]

{
  "__objType": "ChangeContactInfoEmailResult", 
  "resultCode": "Success"
}

Related objects:

  • ~ManyToOne/ContactInformation

ProfileGroup

Generic operations: POST, GET, PUT, DELETE

Related objects:

  • ~ManyToOne/Organization

  • ~Membership/Profile

  • ~OneToMany/ProfileGroupRole

  • ~GroupMembership/ProfileGroup

VatNumber

Generic operations: POST, GET, PUT, DELETE

Related objects:

  • ~ManyToOne/Organization

DunsNumber

Generic operations: POST, GET, PUT, DELETE

Related objects:

  • ~ManyToOne/Organization

Person

Generic operations: POST, GET, PUT, DELETE

Related objects:

  • ~OneToMany/Profile

  • ~OneToMany/EmailAndPassword

TechnicalActor

Generic operations: POST, GET, PUT, DELETE

Related objects:

  • ~OneToMany/EmailAndPassword

On this page