REST API 2.0 - CustomerID

Owned by John Jellema
2021-12-17

Last reviewed: 2019-08-12


XML Schema

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
    version="2.0" xmlns="http://schema.ubisecure.com/customerid/api"
    targetNamespace="http://schema.ubisecure.com/customerid/api"
    elementFormDefault="qualified">
    <!-- core entity objects -->
    <xs:element name="User" type="EntityType" />
    <xs:element name="Organization" type="EntityType" />
    <xs:element name="Role" type="EntityType" />
    <xs:element name="Mandate" type="EntityType" />
    <xs:element name="Workflow" type="EntityType" />
    <!-- relation objects -->
    <xs:element name="MandateTemplate" type="EntityType" />
    <xs:element name="RoleInvitation" type="EntityType" />
    <!-- collections -->
    <xs:element name="Roles" type="IdListType" />
    <xs:element name="Mandates" type="IdListType" />
    <xs:element name="Users" type="IdListType" />
    <xs:element name="Organizations" type="IdListType" />
    <xs:element name="Workflows" type="IdListType" />
    <xs:element name="RoleInvitations" type="IdListType" />
    <xs:element name="MandateInvitations" type="IdListType" />
    <xs:complexType name="EntityType">
        <xs:sequence>
            <xs:element name="Attribute" type="AttributeType"
                maxOccurs="unbounded" />
        </xs:sequence>
        <xs:attribute name="inResponseTo" type="xs:anyURI"/>
        <xs:attribute name="method" type="httpMethod"/>
        <xs:attribute name="type" type="xs:string"/>
    </xs:complexType>
    <xs:complexType name="IdListType">
        <xs:annotation>
            <xs:documentation>
                Since customerid-rest-schema 2.0:
                roleInvitation contains a list of ids that are either
                relative or absolute URLs. inResponseTo attribute
                indicates what kind of query this message was produced
                by
            </xs:documentation>
        </xs:annotation>
        <xs:sequence>
            <xs:element name="Id" type="IdType" maxOccurs="unbounded" minOccurs="0"/>
            <xs:element name="User" type="EntityType" maxOccurs="unbounded" minOccurs="0"/>
            <xs:element name="Organization" type="EntityType" maxOccurs="unbounded" minOccurs="0"/>
            <xs:element name="Role" type="EntityType" maxOccurs="unbounded" minOccurs="0"/>
            <xs:element name="Mandate" type="EntityType" maxOccurs="unbounded" minOccurs="0"/>
        </xs:sequence>
        <xs:attribute name="inResponseTo" type="xs:anyURI" />
        <xs:attribute name="method" type="httpMethod" use="required" />
    </xs:complexType>
    <xs:complexType name="AttributeType">
        <xs:choice>
            <xs:element name="Value" type="AttributeValueType" minOccurs="0" maxOccurs="unbounded"/>
            <xs:element name="Entity" type="EntityType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:choice>
        <xs:attribute name="name" type="xs:string" />
    </xs:complexType>
    <xs:complexType name="AttributeValueType">
        <xs:simpleContent>
            <xs:extension base="xs:string">
                <xs:attribute name="type" type="xs:string" />
            </xs:extension>
        </xs:simpleContent>
    </xs:complexType>
    <xs:simpleType name="IdType">
        <xs:restriction base="xs:string" />
    </xs:simpleType>
    <xs:simpleType name="httpMethod">
        <xs:restriction base="xs:token">
            <xs:enumeration value="GET" />
            <xs:enumeration value="PUT" />
            <xs:enumeration value="POST" />
            <xs:enumeration value="DELETE" />
            <xs:enumeration value="UPDATE" />
            <xs:enumeration value="HEAD" />
            <xs:enumeration value="STATUS" />
            <xs:enumeration value="CONNECT" />
            <xs:enumeration value="OPTIONS" />
            <xs:enumeration value="TRACE" />
        </xs:restriction>
    </xs:simpleType>
</xs:schema>

Modification Operations

MOD001 Create Organization

Description

Create a new organization.

Target Type

Collection

Request URL

Request URL should point to the root of the organizations collection.

Example

  • https://HOSTNAME/customerid-rest/services/2.0/organizations/

Request Method

POST

Request URL Parameters

Name

Accepted Values

Multivalued

Mandatory

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.

organizationClass

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

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

Response Document

 <Organizations xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.0/organizations/" method="POST">
  <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</id>
 </Organizations>

MOD003 Update Organization

Description

Update the organization data. Replaces all the defined attributes, empty value removes the attribute, and missing attribute does not change the existing value.

Target Type

Entity

Request URL

Request URL defines the organization to be updated.

Example

  • https://HOSTNAME/customerid-rest/services/2.0/organizations/ORGANIZATIONID

Request Method

PUT

Request URL Parameters

Name

Accepted Values

Multivalued

Mandatory

Default

Description

friendlyName

String

 

 

 

Human readable name of the organization.

organizationClass

String from Configured Set

 

 

 

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). These attributes must have been defined in eidm2.properties (data.organization.fields or ui.admin.organizationinfo.fields.order) For example, organizationid=12345

Curl Example

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

Response Document

 <Organizations xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.0/organizations/27e326f1-b6ad-46a6-917f-1c3c377c73ee" method="PUT">
  <Id>27e326f1-b6ad-46a6-917f-1c3c377c73ee</id>
 </Organizations>

MOD010 Delete User

Description

Delete the specified user.

Target Type

Entity

Request URL

Request URL defines the user to be deleted.

Example

  • https://HOSTNAME/customerid-rest/services/2.0/users/USERID

Request Method

DELETE

Request URL Parameters

No request specific request URL parameters.

Curl Example

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

Response Document

 <Users xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" method="DELETE">
  <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</id>
 </Users>

MOD004 Update User

Description

Update the user information. Replaces all the defined attributes, empty value removes the attribute, and missing attribute does not change the existing value.

Target Type

Entity

Request URL

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

Example

  • https://HOSTNAME/customerid-rest/services/2.0/users/USERID1

Request Method

PUT

Request URL Parameters

Name

Accepted Values

Multivalued

Mandatory

Default

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.

See Data model - CustomerID for more information on user statuses.

"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

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

Response Document

 <Users xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" method="PUT">
  <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</id>
 </Users>

Request Operations

REQ001 List Users

Description

List users in the system / organization and / or based on some search criteria.

Target Type

Collection

Request URL

Request URL defines the organization which users are to be listed and / or the search criteria. You may also list all users from the system.

Examples

  • https://HOSTNAME/customerid-rest/services/2.0/users/
  • https://HOSTNAME/customerid-rest/services/2.0/organizations/ORGANIZATIONID/users
  • https://HOSTNAME/customerid-rest/services/2.0/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 (only when listing is performed based on organization path). When query is performed to base path for users the search is global.

<any user attribute name>

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.

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). The attribute is not applicable when users are searched within an organization.

Curl Example

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

Response Document

List of Identifiers

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

List of Identifiers from organization based path

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

REQ002 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.0/users/USERID

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

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

Response Document

<?xml version="1.0" encoding="utf-8"?>
 <User xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.0/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>

Supported values

  • Status: See Data model - CustomerID for a list of user statuses.
  • Attributes: Includes user's all attributes (including custom attributes).

Subpaths

  • Role invitations (REQ011c): https://HOSTNAME/customerid-rest/services/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roleinvitations
  • Received mandates (REQ007): https://HOSTNAME/customerid-rest/services/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates
  • Given mandates (REQ007): https://HOSTNAME/customerid-rest/services/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates
  • Received mandate delegations (REQ007): https://HOSTNAME/customerid-rest/services/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandatedelegations
  • Received roles (REQ051): https://HOSTNAME/customerid-rest/services/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roles

REQ003 List Organizations

Description

List organizations.

Target Type

Collection

Request URL

Request URL points to the root of organizations container.

Example

  • https://HOSTNAME/customerid-rest/services/2.0/organizations/

Request Method

GET

Request URL Parameters

Name

Accepted Values

Multivalued

Mandatory

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.

organizationClass

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 REQ004 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).

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

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

Response Document

List of Identifiers

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

REQ004 Query Organization

Description

Query information about the specified organization.

Target Type

Entity

Request URL

Request URL defines the queried organization.

Example

  • https://HOSTNAME/customerid-rest/services/2.0/organizations/ORGANIZATIONID

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

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

Response Document

<?xml version="1.0" encoding="utf-8"?>
 <Organization xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.0/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>

Subpaths

  • Given mandates (REQ007): https://HOSTNAME/customerid-rest/services/2.0/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates
  • Received mandates (REQ007): https://HOSTNAME/customerid-rest/services/2.0/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates

REQ051 List Roles

Description

List roles in system or per user

Target Type

Collection

Request URL

Examples

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

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

  • List all roles in system

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

  • List roles assigned to user

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

Response Document

List of Roles in system scope

 <Roles xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.0/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>

List of Roles per user

<Roles xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.0/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>

REQ005 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.0/roles/ROLEID

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

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

Response Document

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

REQ007 List Mandates

Description

List all mandates, or only mandates received/given by a user/organization.

Target Type

Collection

Request URL

Examples

  • https://HOSTNAME/customerid-rest/services/2.0/mandates/
  • https://HOSTNAME/customerid-rest/services/2.0/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates
  • https://HOSTNAME/customerid-rest/services/2.0/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates
  • https://HOSTNAME/customerid-rest/services/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates
  • https://HOSTNAME/customerid-rest/services/2.0/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates
  • https://HOSTNAME/customerid-rest/services/2.0/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.

Response Document

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

Curl Examples

List all mandates in system

curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.0/mandates/" 
 <Mandates xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://localhost:7443/customerid-rest/services/2.0/mandates" method="GET">
  <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
  <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
 </Mandates>

List all mandates given by organization.

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

List all mandates received by an organization.

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

List all mandates received by a user.

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

List all mandates given by a user.

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

List all mandates delegated to a user.

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

REQ008 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.0/mandates/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

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

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

Response Document

<Mandate inResponseTo="/2.0/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>

REQ011 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.0/roleinvitations/

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

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

Response Document

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

REQ011c 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.0/users/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/roleinvitations

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

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

Response Document

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

Ubisecure Privacy Policy & Cookie Statement