Last reviewed: 2019-09-17 |
REST API 2.1 is available since CustomerID 5.1 |
<?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> |
Create a new organization.
Collection
Request URL should point to the root of the organizations collection.
POST
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 --insecure -X POST -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/?friendlyName=Luotava%20Organisaatio&parentOrganizationId=d9cbed24-d3b7-4611-ae8f-f0327eb60a48" |
<Organizations xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/organizations/" method="POST"> <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id> </Organizations> |
Update the organization data. Replaces all the defined attributes, empty value removes the attribute, and missing attribute does not change the existing value.
Entity
Request URL defines the organization to be updated.
PUT
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 --insecure -X PUT -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/27e326f1-b6ad-46a6-917f-1c3c377c73ee?friendlyName=TestOrganizationRENAME" |
<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> |
Delete the specified user.
Entity
Request URL defines the user to be deleted.
DELETE
No request specific request URL parameters.
curl --insecure -X DELETE -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" |
<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> |
Update the user information. Replaces all the defined attributes, empty value removes the attribute, and missing attribute does not change the existing value.
Entity
Request URL defines the user to be updated based on the user ID of the user.
PUT
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
---|---|---|---|---|---|
login | String |
|
|
| User login name. |
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 --insecure -X PUT -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?mobile=+358401234567891&status=Enabled" |
<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> |
List users in the system. You can limit the returned users based on given search criteria.
Collection
Request URL defines the search criteria. You may also list all users from the system by not using any limiting criteria values.
GET
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. 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). |
List all users
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/" |
List all pending users
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users?status=0" |
List all enabled users
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users?status=Enabled" |
<Users xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/users" method="GET"> <Id>USERID1</Id> <Id>USERID2</Id> </Users> |
List users from an organization. You can limit the returned users based on given search criteria.
Collection
Request URL defines the organization which users are to be listed and possibly the search criteria.
GET
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 . 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 --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/users/?recursive=true" |
<Users xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/users" method="GET"> <Id>USERID2</Id> </Users> |
Query information about the specified user based on the user ID of the user.
Entity
Request URL defines the queried user based on the user ID of the user.
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" |
<?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> |
List organizations.
Collection
Request URL points to the root of organizations container.
GET
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). |
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 --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/" |
<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> |
Query information about the specified organization.
Entity
Request URL defines the queried organization.
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/27e326f1-b6ad-46a6-917f-1c3c377c73ee" |
<?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> |
List roles in the system.
Collection
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/roles" |
<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> |
List roles that the defined user is a member of.
Collection
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roles" |
<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> |
Query information about the specified role.
Entity
Request URL defines the queried role.
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/roles/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" |
<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> |
List all mandates in the system.
Collection
GET
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
---|---|---|---|---|---|
entities | Boolean |
|
| false | Return list of entities instead of id list. |
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/mandates/" |
<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> |
List mandates given by the defined organization.
Collection
GET
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
---|---|---|---|---|---|
entities | Boolean |
|
| false | Return list of entities instead of id list. |
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates" |
<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> |
List mandates received by the defined organization.
Collection
GET
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
---|---|---|---|---|---|
entities | Boolean |
|
| false | Return list of entities instead of id list. |
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates" |
<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> |
List mandates given by the defined user.
Collection
GET
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
---|---|---|---|---|---|
entities | Boolean |
|
| false | Return list of entities instead of id list. |
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/givenmandates" |
<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> |
List mandates received by the defined user.
Collection
GET
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
---|---|---|---|---|---|
entities | Boolean |
|
| false | Return list of entities instead of id list. |
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandates" |
<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> |
List mandates delegated to the defined user.
Collection
GET
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
---|---|---|---|---|---|
entities | Boolean |
|
| false | Return list of entities instead of id list. |
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/receivedmandatedelegations" |
<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> |
Query information about the specified mandate.
Entity
Request URL defines the queried mandate.
GET
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
---|---|---|---|---|---|
entities | Boolean |
|
| false | Include referenced objects as entities instead of just ID references. |
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/mandates/e8bba13e-e965-4042-af70-2b51d59359a2" |
<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> |
List role invitations.
Collection
Request URL defines that we want to list all role invitations.
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/roleinvitations" |
<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> |
List role invitations for user.
Collection
Request URL defines the user whose role invitations are to be listed.
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/roleinvitations" |
<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> |
List mandate role delegations for user.
Collection
Request URL defines the user whose mandate role delegations are to be listed.
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/delegations" |
<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> |
Query mandate role delegation.
Collection
Request URL defines the delegation which data should be retrieved.
GET
No request specific request URL parameters.
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/delegations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" |
<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> |