Versions Compared

Old Version 7

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Tomi Pelttari

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space IDS and version 8.2

Table of Contents
maxLevel2

XML Schema

Code Block
languagetext
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
    version="2.1" 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" />
    <xs:element name="Delegation" 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:element name="Delegations" 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:element name="Delegations" 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

POST100 Create Organization

Description

Create a new organization.

Target Type

Collection

Request URL

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

Examples

  • https://HOSTNAME/customerid-rest/services/2.1/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.

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
languagetext
curl --insecure -X POST "https://localhost:7443/customerid-rest/services/2.1/organizations/?
username=restuser&password=secret&friendlyName=Luotava%20Organisaatio&parentOrganizationId=d9cbed24-d3b7-4611-ae8f-f0327eb60a48"

Response Document

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

PUT101 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.

Examples

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

Request Method

PUT

Request URL Parameters

Name

Accepted Values

Multivalued

Mandatory

Default

Description

friendlyName

String

 

 

 

Human readable name of the organization.

organizationType

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

Code Block
languagetext
curl --insecure -X PUT "https://localhost:7443/customerid-rest/services/2.1/organizations/27e326f1XXXXXXXX-b6adXXXX-46a6XXXX-917fXXXX-1c3c377c73eeXXXXXXXXXXXX?username=restuser&password=secret&friendlyName=TestOrganizationRENAME"

Response Document

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

DEL102

...

Remove User

Description

Delete Remove the specified user.

Target Type

Entity

Request URL

Request URL defines the user to be deletedremoved.

Example

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

Request Method

DELETE

Request URL Parameters

No request specific request URL parameters.

Curl Example

Code Block
languagetext
curl --insecure -X DELETE "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret"

Response Document

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

PUT103 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.1/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.

"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
languagetext
curl --insecure -X PUT "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret&mobile=+358401234567891%2B358401234567891&status=Enabled"

Response Document

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

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.

Examples

  • 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

<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. Values for user status are: 0=Pending, 1=Enabled, 2=Disabled, 3=Locked. You can also use the textual values instead of the integers. For example "Pending" is equally suitable as "0".

maxResults

Integer

 

 

No Limit

Limit the maximum number of results.

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 Example

Code Block
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/users/?username=restuser&password=secret"

Response Document

List of Identifiers

Code Block
languagetext
<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.

Examples

  • 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.

<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. Values for user status are: 0=Pending, 1=Enabled, 2=Disabled, 3=Locked.

maxResults

Integer

 

 

No Limit

Limit the maximum number of results.

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 Example

Code Block
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/users/?username=restuser&password=secret&recursive=true"

Response Document

List of Identifiers

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://HOSTNAMElocalhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret"

Response Document

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

Supported values

  • Status: Enabled, Disabled and Pending.
  • Attributes: Includes user's all attributes (including custom attributes).

Subpaths

  • Role invitations (GET114): https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roleinvitations
  • Received mandates (GET121): https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates
  • Given mandates (GET120): https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates
  • Received mandate delegations (GET122): https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandatedelegations
  • Received roles (GET117): https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roles

GET106 List Organizations

Description

List organizations.

Target Type

Collection

Request URL

Request URL points to the root of organizations container.

Examples

  • https://HOSTNAME/customerid-rest/services/2.1/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.

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

Curl Example

Code Block
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/organizations/?username=restuser&password=secret"

Response Document

List of Identifiers

Code Block
languagetext
<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.

Examples

  • 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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/organizations/27e326f1-b6ad-46a6-917f-1c3c377c73ee?username=restuser&password=secret"

Response Document

Note: Organization custom attributes that have not been set (i.e. value is null) will not be returned in API responses.

Code Block
languagetext
<?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>

Subpaths

  • 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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/roles?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roles?username=restuser&password=secret"


Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/roles/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/mandates/?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandatedelegations?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/mandates/e8bba13e-e965-4042-af70-2b51d59359a2?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/roleinvitations?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roleinvitations?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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 (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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/delegations?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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
languagetext
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/delegations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret"

Response Document

Code Block
languagetext
<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>

...