...
XML Schema
Code Block | ||||
---|---|---|---|---|
| ||||
<?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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<Organizations xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/organizations/" method="POST"> <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id> </Organizations> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X PUT "https://localhost:7443/customerid-rest/services/2.1/organizations/27e326f1-b6ad-46a6-917f-1c3c377c73ee?username=restuser&password=secret&friendlyName=TestOrganizationRENAME" |
Response Document
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X PUT "https://localhost:7443/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret&mobile=+358401234567891&status=Enabled" |
Response Document
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/users/?username=restuser&password=secret" |
...
List of Identifiers
Code Block | ||||
---|---|---|---|---|
| ||||
<Users xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/users" method="GET"> <Id>USERID1</Id> <Id>USERID2</Id> </Users> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/users/?username=restuser&password=secret&recursive=true" |
...
List of Identifiers
Code Block | ||||
---|---|---|---|---|
| ||||
<Users xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/users" method="GET"> <Id>USERID2</Id> </Users> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X GET "https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret" |
Response Document
Code Block | ||||
---|---|---|---|---|
| ||||
<?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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/organizations/?username=restuser&password=secret" |
...
List of Identifiers
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/organizations/27e326f1-b6ad-46a6-917f-1c3c377c73ee?username=restuser&password=secret" |
Response Document
Code Block | ||||
---|---|---|---|---|
| ||||
<?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 class</Value> </Attribute> <Attribute name="memberships"> <Value>memberships</Value> </Attribute> <Attribute name="customAttribute"> <Value>attributeValue</Value> </Attribute> </Organization> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/roles?username=restuser&password=secret" |
Response Document
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/mandates/?username=restuser&password=secret" |
Response Document
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/2.1/roleinvitations?username=restuser&password=secret" |
Response Document
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...
Curl Example
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
<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> |
...