Info
Last reviewed: 2021-07-22

POST

Request URL Parameters

Name	Accepted Values	Multivalued	Default	Description
virtual	Boolean		false	Defines whether the organization is virtual.
technicalName	String		A generated value in UUID format.	Technical name of the organization to be created.
friendlyName	String		The same as technical name.	Human readable name of the organization.
parentOrganizationId	Organization ID		Root organization.	Organization ID of the organization under which the new organization will be created.
organizationType	String from Configured Set		The configured default organization type. A separate default exists for normal and virtual organizations.	Organization type defining the initial configuration of the created organization.
"custom attribute"	String	X		Organization's custom attribute and a value (multiple values are separated with comma). For example, vatnumber=12345

Curl Example

Code Block

language	text

curl --insecure -X POST -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/?friendlyName=Luotava%20Organisaatio&parentOrganizationId=d9cbed24-d3b7-4611-ae8f-f0327eb60a48"

...

PUT

Request URL Parameters

Name	Accepted Values	Multivalued	Description
friendlyName	String		Human readable name of the organization.
organizationType	String from Configured Set		Organization type defining the initial configuration of the created organization. Role to role mappings shall be refreshed based on role hierarchy rules only if the organization type is modified.
"custom attribute"	String	X	Organization's custom attribute and a value (multiple values are separated with comma). These attributes must have been defined in eidm2.properties (data.organization.fields or ui.admin.organizationinfo.fields.order) For example, organizationid=12345

Curl Example

Code Block

language	text

curl --insecure -X PUT -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/27e326f1-b6ad-46a6-917f-1c3c377c73ee?friendlyName=TestOrganizationRENAME"

...

PUT

Request URL Parameters

Name	Accepted Values	Multivalued	Description
login	String		User login name.
email	String		User email address.
firstname	String		First name of the user.
surname	String		Surname of the user.
mobile	String		Mobile phone number.
ssn	String		Social Security Number (henkilötunnus)
locale	String		User preferred locale setting.
pwd	String		New password.
pwd.activated	Boolean		Defines if the password authentication method is active for the user or not.
status	String from Configured Set		Set the user status Enabled or Disabled. For more information on user statuses see Data model - CustomerID.
"custom attribute"	String	X	User's custom attribute and a value. For example, age=45. Adding multiple key-value parameters with the same key will create multi-valued attributes. For example, browsers=IE&browsers=chrome.

Curl Example

Code Block

language	text

curl --insecure -X PUT -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?mobile=+358401234567891&status=Enabled"

...

Request URL defines the user to be updated based on the user ID of the user.

Examples:

https://HOSTNAME/customerid-rest/services/2.1/users/USERID1

Request Method

PATCH

Request Parameters

...

With Content-Type header on application/x-www-form-urlencoded

Name	Accepted Values	Multivalued	Description
login	String		User login name.
email	String		User email address.
firstname	String		First name of the user.
surname	String		Surname of the user.
mobile	String		Mobile phone number.
ssn	String		Social Security Number (henkilötunnus)
locale	String		User preferred locale setting.
pwd	String		New password.
pwd.activated	Boolean		Defines if the password authentication method is active for the user or not.
status	String from Configured Set		Set the user status Enabled or Disabled. For more information on user statuses see Data model - CustomerID.
"custom attribute"	String	X	User's custom attribute and a value. For example, age=45. Adding multiple key-value parameters with the same key will create multi-valued attributes. For example, browsers=IE&browsers=chrome.

XML

With Content-Type header on application/xml

Info
Custom Attributes are saved as multivalued. To add multiple value, add multiple values as shown below (Custom1). To remove custom attribute, give no values or give empty value.

...

Code Block

{
    "firstname": "Firstname",
    "surname": "Surname",
    "login": "Username",
    "email": "email@example.com",
    "mobile": "+358501234567",
    "ssn": "111111-111C",
    "locale": "en",
    "status": "Enabled",
    "customAttributes": {
        "Custom2": "Value3",
        "Custom1": [
            "Value1",
            "Value2"
        ]
    },
    "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "repoId": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
    "organization": "Users",
    "organizationEntityName": "Users"
}

PUT125 Force Password Change for User

Description

Updates User so that they are forced to change password next time are logging in with a password method.

Works only when user repository is Ubilogin Directory. When user repository is Active Directory, an error response is returned with status code 404.

Target Type

None.

Request URL

Request URL defines the user to be forced to be change password based on the user ID of the user.

Example

https://HOSTNAME/customerid-rest/services/2.1/users/USERID/forcepasswordchange

Request Method

PUT

Request URL Parameters

No request specific request URL parameters.

Curl Example

curl --insecure -X PUT -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/forcepasswordchange

Response Status

204 No Content

Response Document

None.

Request Operations

GET104 List Users

Description

List users in the system. You can limit the returned users based on given search criteria.

Target Type

Collection

Request URL

Request URL defines the search criteria. You may also list all users from the system by not using any limiting criteria values.

...

https://HOSTNAME/customerid-rest/services/2.1/users/
https://HOSTNAME/customerid-rest/services/2.1/users?attributeName=attributeValue&attribute2Name=attribute2Value

Request Method

GET

Request URL Parameters

Name

Accepted Values

Multivalued

Mandatory

Default

Description

String

Include only users with exact matching search criteria value for the specified attribute name(s). You may use any of the builtin or custom attribute names here. The value given is searched from the attribute defined. You may use multiple different attribute names (and limiting search criteria values) in a single query (all must then match for the result to be returned). You cannot use the same attribute name multiple times in a single query.

You can also search by user status. Use either the status code or the status technical name. For example "pending" is equally suitable as "0". See Data model - CustomerID for a list of user statuses.

maxResults

Integer

No Limit

Limit the maximum number of results. A value of zero means no limit.

exactMatch

Boolean

false

When limiting attribute values are used, this parameter defines if the value must be found exactly like given (true) or if the database value just needs to start with the given value (false).

Curl Examples

List all users

...

Code Block
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users?status=Enabled"

Response Document

List of Identifiers

Code Block

language	text

<Users xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/users" method="GET">
 <Id>USERID1</Id>
 <Id>USERID2</Id>
</Users>

GET113 List Organization's Users

Description

List users from an organization. You can limit the returned users based on given search criteria.

Target Type

Collection

Request URL

Request URL defines the organization which users are to be listed and possibly the search criteria.

...

https://HOSTNAME/customerid-rest/services/2.1/organizations/ORGANIZATIONID/users
https://HOSTNAME/customerid-rest/services/2.1/organizations/ORGANIZATIONID/users?attributeName=attributeValue&attribute2Name=attribute2Value

Request Method

GET

Request URL Parameters

Name

Accepted Values

Multivalued

Mandatory

Default

Description

recursive

Boolean

false

Include users from the suborganizations.

String

Include only users with exact matching search criteria value for the specified attribute name(s). You may use any of the builtin or custom attribute names here. The value given is searched from the attribute defined. You may use multiple different attribute names (and limiting search criteria values) in a single query (all must then match for the result to be returned). You cannot use the same attribute name multiple times in a single query.

You can also search by user status . Use either the status code or the status technical name. For example "pending" is equally suitable as "0". See Data model - CustomerID for a list of user status es.

maxResults

Integer

No Limit

Limit the maximum number of results. A value of zero means no limit.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/users/?recursive=true"

Response Document

List of Identifiers

Code Block

language	text

<Users xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/users" method="GET">
 <Id>USERID2</Id>
</Users>

GET105 Query User

Description

Query information about the specified user based on the user ID of the user.

Target Type

Entity

Request URL

Request URL defines the queried user based on the user ID of the user.

Example

https://HOSTNAME/customerid-rest/services/2.1/users/USERID

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

Response Document

Code Block

language	text

<?xml version="1.0" encoding="utf-8"?>
 <User xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" method="GET">
   <Attribute name="id">
     <Value>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</Value>
   </Attribute>
   <Attribute name="firstname">
     <Value>Firstname</Value>
   </Attribute>
   <Attribute name="surname">
     <Value>Lastname</Value>
   </Attribute>
   <Attribute name="mobile">
     <Value>+0123456789</Value>
   </Attribute>
   <Attribute name="cn">
     <Value>YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY</Value>
   </Attribute>
   <Attribute name="login">
     <Value>firstname.lastname</Value>
   </Attribute>
   <Attribute name="email">
     <Value>firstname.lastname@example.org</Value>
   </Attribute>
   <Attribute name="ssn">
     <Value>010199-1234</Value>
   </Attribute>
   <Attribute name="organization">
     <Value>My Subsidiary</Value>
   </Attribute>
   <Attribute name="organizationEntityName">
     <Value>5555555-6/1234567-1</Value>
   </Attribute>
   <Attribute name="organizationId">
     <Value>ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ</Value>
   </Attribute>
   <Attribute name="status">
     <Value>Enabled</Value>
   </Attribute>
</User>

...

GET106 List Organizations

Description

List organizations.

Target Type

Collection

Request URL

Request URL points to the root of organizations container.

...

https://HOSTNAME/customerid-rest/services/2.1/organizations/

Request Method

GET

Request URL Parameters

Name	Accepted Values	Default	Description
entityName	Entity Name		Search organization by its entity name.
technicalName	String		Search organization by its technical name.
friendlyName	String		Search organizations by their friendly name.
organizationType	String from Configured Set		Search organizations by their organization type.
<any organization attribute name>	String		Include only organizations with matching search criteria value for the specified attribute name(s). You may use any of the builtin or custom attribute names here that are present in GET107 output. The value given is searched from the attribute defined. You may use multiple different attribute names (and limiting search criteria values) in a single query (all must then match for the result to be returned). You cannot use the same attribute name multiple times in a single query.
exactMatch	Boolean	false	When limiting attribute values are used, this parameter defines if the value must be found exactly like given (true) or if the database value just needs to start with the given value (false).

Note
Try to avoid creating too large or complex queries as they may affect the overall performance of the system. For example before adding several custom attributes to limit results, check the performance impact first in the test environment.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/"

Response Document

List of Identifiers

Code Block

language	text

<Organizations xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/organizations/" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</Id>
 <Id>YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY</Id>
</Organizations>

GET107 Query Organization

Description

Query information about the specified organization.

Target Type

Entity

Request URL

Request URL defines the queried organization.

...

https://HOSTNAME/customerid-rest/services/2.1/organizations/ORGANIZATIONID

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/27e326f1-b6ad-46a6-917f-1c3c377c73ee"

Response Document

Code Block

language	text

<?xml version="1.0" encoding="utf-8"?>
<Organization xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" method="GET">
  <Attribute name="entityName">
    <Value>Organization/EntityName</Value>
  </Attribute>
  <Attribute name="friendlyName">
    <Value>Organization Friendly Name</Value>
  </Attribute>
  <Attribute name="organizationClass">
    <Value>organization type</Value>
  </Attribute>
  <Attribute name="memberships">
    <Value>memberships</Value>
  </Attribute>
  <Attribute name="customAttribute">
    <Value>attributeValue</Value>
  </Attribute>
</Organization>

...

Given mandates (GET118): https://HOSTNAME/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates
Received mandates (GET119): https://HOSTNAME/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates

GET108 List Roles

Description

List roles in the system.

Target Type

Collection

Request URL

https://HOSTNAME/customerid-rest/services/2.1/roles

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/roles"

Response Document

Code Block

language	text

<Roles xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.1/roles" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX3</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX4</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX5</Id>
</Roles>

GET117 List User's Roles

Description

List roles that the defined user is a member of.

Target Type

Collection

Request URL

https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roles

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roles"

Response Document

Code Block

language	text

<Roles xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roles" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX3</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX4</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX5</Id>
</Roles>

GET109 Query Role

Description

Query information about the specified role.

Target Type

Entity

Request URL

Request URL defines the queried role.

Example

https://HOSTNAME/customerid-rest/services/2.1/roles/ROLEID

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/roles/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

Response Document

Code Block

language	text

<Role xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/roles/ROLEID" method="GET">
 <Attribute name="name">
    <Value>ROLENAME</Value>
 </Attribute>
 <Attribute name="entityName">
    <Value>1234567-1/ROLENAME</Value>
 </Attribute>
</Role>

GET110 List Mandates

Description

List all mandates in the system.

Target Type

Collection

Request URL

Example

https://HOSTNAME/customerid-rest/services/2.1/mandates/

Request Method

GET

Request URL Parameters

Name	Accepted Values	Multivalued	Mandatory	Default	Description
entities	Boolean			false	Return list of entities instead of id list.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/mandates/"

Response Document

Code Block

language	text

<Mandates xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/mandates" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</Mandates>

GET118 List Organization's Given Mandates

Description

List mandates given by the defined organization.

Target Type

Collection

Request URL

Example

https://HOSTNAME/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates

Request Method

GET

Request URL Parameters

Name	Accepted Values	Multivalued	Mandatory	Default	Description
entities	Boolean			false	Return list of entities instead of id list.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates"

Response Document

Code Block

language	text

<Mandates xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</Mandates>

GET119 List Organization's Received Mandates

Description

List mandates received by the defined organization.

Target Type

Collection

Request URL

Example

https://HOSTNAME/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates

Request Method

GET

Request URL Parameters

Name	Accepted Values	Multivalued	Mandatory	Default	Description
entities	Boolean			false	Return list of entities instead of id list.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates"

Response Document

Code Block

language	text

<Mandates xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</Mandates>

GET120 List User's Given Mandates

Description

List mandates given by the defined user.

Target Type

Collection

Request URL

Example

https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates

Request Method

GET

Request URL Parameters

Name	Accepted Values	Multivalued	Mandatory	Default	Description
entities	Boolean			false	Return list of entities instead of id list.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates"

Response Document

Code Block

language	text

<Mandates xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</Mandates>

GET121 List User's Received Mandates

Description

List mandates received by the defined user.

Target Type

Collection

Request URL

Example

https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates

Request Method

GET

Request URL Parameters

Name	Accepted Values	Multivalued	Mandatory	Default	Description
entities	Boolean			false	Return list of entities instead of id list.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates"

Response Document

Code Block

language	text

<Mandates xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</Mandates>

GET122 List User's Received Mandate Delegations

Description

List mandates delegated to the defined user.

Target Type

Collection

Request URL

Example

https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandatedelegations

Request Method

GET

Request URL Parameters

Name	Accepted Values	Multivalued	Mandatory	Default	Description
entities	Boolean			false	Return list of entities instead of id list.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandatedelegations"

Response Document

Code Block

language	text

<Mandates xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandatedelegations" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</Mandates>

GET111 Query Mandate

Description

Query information about the specified mandate.

Target Type

Entity

Request URL

Request URL defines the queried mandate.

Example

https://HOSTNAME/customerid-rest/services/2.1/mandates/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Request Method

GET

Request URL Parameters

Name	Accepted Values	Multivalued	Mandatory	Default	Description
entities	Boolean			false	Include referenced objects as entities instead of just ID references.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/mandates/e8bba13e-e965-4042-af70-2b51d59359a2"

Response Document

Code Block

language	text

<Mandate inResponseTo="/2.1/mandates/e8bba13e-e965-4042-af70-2b51d59359a2" method="GET">
 <Attribute name="id">
  <Value>e8bba13e-e965-4042-af70-2b51d59359a2</Value>
 </Attribute>
 <Attribute name="type">
  <Value>OrgToPer</Value>
 </Attribute>
 <Attribute name="entityName">
  <Value>Test%20User4z8y6pkhpya89zde5drs</Value>
 </Attribute>
 <Attribute name="name">
  <Value>Test User4z8y6pkhpya89zde5drs</Value>
 </Attribute>
 <Attribute name="assigneeEmail">
  <Value>test.user@example.org</Value>
 </Attribute>
 <Attribute name="mandater" type="organization">
  <Value>eb74ea0e-06f3-4575-aea0-13538e167e5f</Value>
 </Attribute>
 <Attribute name="mandatee" type="user">
  <Value>08a644dc-e6b4-4079-a636-5f378d876ee8</Value>
 </Attribute>
 <Attribute name="role" type="role">
  <Value>283cee64-2b42-4052-906a-9fa683829312</Value>
 </Attribute>
</Mandate>

GET112 List Role Invitations

Description

List role invitations.

Target Type

Collection

Request URL

Request URL defines that we want to list all role invitations.

Example

https://HOSTNAME/customerid-rest/services/2.1/roleinvitations/

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/roleinvitations"

Response Document

Code Block

language	text

<RoleInvitations xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/roleinvitations" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</RoleInvitations>

GET114 List Role Invitations (for user)

Description

List role invitations for user.

Target Type

Collection

Request URL

Request URL defines the user whose role invitations are to be listed.

Example

https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/roleinvitations

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roleinvitations"

Response Document

Code Block

language	text

<RoleInvitations xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roleinvitations" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</RoleInvitations>

GET115 List Received Mandate Role Delegations (for user)

Description

List mandate role delegations for user.

Target Type

Collection

Request URL

Request URL defines the user whose mandate role delegations are to be listed.

Example

https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/delegations

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/delegations"

Response Document

Code Block

language	text

<Delegations xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/delegations" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
</Delegations>

GET116 Query Mandate Role Delegation

Description

Query mandate role delegation.

Target Type

Collection

Request URL

Request URL defines the delegation which data should be retrieved.

Example

https://HOSTNAME/customerid-rest/services/2.1/delegations/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block

language	text

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/delegations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

Response Document

Code Block

language	text

<Delegation xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.1/delegations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" method="GET">
 <Attribute name="role">
  <Value>ROLEID</Value>
 </Attribute>
 <Attribute name="mandatee">
  <Value>MANDATEEORGANIZATIONID</Value>
 </Attribute>
 <Attribute name="mandate">
  <Value>MANDATEID</Value>
 </Attribute>
 <Attribute name="mandateruser">
  <Value>USERID</Value>
 </Attribute>
 <Attribute name="mandaterorganization">
  <Value>ORGANIZATIONID</Value>
 </Attribute>
</Delegation>

...

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Request URL Parameters

Curl Example

Request URL Parameters

Curl Example

Request URL Parameters

Curl Example

Request Method

Request Parameters

XML

PUT125 Force Password Change for User

Description

Target Type

Request URL

Example

Request Method

Request URL Parameters

Curl Example

Response Status

Response Document

Request Operations

GET104 List Users

Description

Target Type

Request URL

Request Method

Request URL Parameters

Curl Examples

Response Document

List of Identifiers

GET113 List Organization's Users

Description

Target Type

Request URL

Request Method

Request URL Parameters

Curl Example

Response Document

List of Identifiers

GET105 Query User

Description

Target Type

Request URL

Example

Request Method

Request URL Parameters

Curl Example

Response Document

GET106 List Organizations

Description

Target Type

Request URL

Request Method

Request URL Parameters

Curl Example

Response Document

List of Identifiers

GET107 Query Organization

Description

Target Type

Request URL

Request Method

Request URL Parameters

Curl Example

Response Document

GET108 List Roles

Description

Target Type

Request URL

Request Method

Request URL Parameters

Curl Example

Response Document

GET117 List User's Roles

Description

Target Type