...
XML Schema
Code Block |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="organization">
<xs:complexType>
<xs:complexContent>
<xs:extension base="organization-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="user">
<xs:complexType>
<xs:complexContent>
<xs:extension base="user-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="pendingUser">
<xs:complexType>
<xs:complexContent>
<xs:extension base="pendingUser-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="role">
<xs:complexType>
<xs:complexContent>
<xs:extension base="role-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="mandatetemplate">
<xs:complexType>
<xs:complexContent>
<xs:extension base="mandatetemplate-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="mandate">
<xs:complexType>
<xs:complexContent>
<xs:extension base="mandate-type"></xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="mandatelist">
<xs:complexType>
<xs:sequence>
<xs:element name="givenmandatelist" type="mandatelist-type" />
<xs:element name="receivedmandatelist" type="mandatelist-type" />
<xs:any namespace="##any" processContents="skip" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="givenmandatelist">
<xs:complexType>
<xs:complexContent>
<xs:extension base="mandatelist-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="receivedmandatelist">
<xs:complexType>
<xs:complexContent>
<xs:extension base="mandatelist-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="entitylist">
<xs:complexType>
<xs:complexContent>
<xs:extension base="entitylist-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="idlist">
<xs:complexType>
<xs:complexContent>
<xs:extension base="idlist-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="mandateidlist">
<xs:complexType>
<xs:sequence>
<xs:element name="givenmandateidlist" type="idlist-type" />
<xs:element name="receivedmandateidlist"
type="idlist-type" />
<xs:any namespace="##any" processContents="skip" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="roleinvitation">
<xs:complexType>
<xs:complexContent>
<xs:extension base="roleinvitation-type" />
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="error">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="message" type="xs:string"
minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- Type definitions -->
<xs:complexType name="organization-type">
<xs:sequence>
<xs:element name="id" type="xs:string" />
<xs:element name="virtual" type="xs:string" />
<xs:element name="friendlyName" type="xs:string" />
<xs:element name="technicalname" type="xs:string" />
<xs:element name="organizationClass" type="xs:string" />
<xs:element name="customattribute" type="customattribute-type"
minOccurs="0" maxOccurs="unbounded" />
<xs:element name="memberships" type="memberships-type" />
<xs:element name="members" type="members-type" />
<xs:element name="roles" type="roles-type" />
<xs:element name="applicationCount" type="xs:string" />
<xs:element name="pendingOrganizations" type="pendingOrganizations-type" />
<xs:element name="givenmandates" type="mandates-type" />
<xs:element name="receivedmandates" type="mandates-type" />
<xs:any namespace="##any" processContents="skip"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="user-type">
<xs:sequence>
<xs:element name="id" type="xs:string" />
<xs:element name="organization" type="xs:string" />
<xs:element name="organizationFriendlyName" type="xs:string" />
<xs:element name="status" type="xs:string" />
<xs:element name="attributes" type="attributes-type" />
<xs:element name="roleassignments" type="roleassignments-type" />
<xs:element name="groupassignments" type="groupassignments-type" />
<xs:element name="authentication" type="authentication-type" />
<xs:element name="givenmandates" type="mandates-type" />
<xs:element name="receivedmandates" type="mandates-type" />
<xs:any namespace="##any" processContents="skip"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="attributes-type">
<xs:sequence>
<xs:element name="uid" type="xs:string" />
<xs:element name="firstname" type="xs:string" />
<xs:element name="surname" type="xs:string" />
<xs:element name="email" type="xs:string" />
<xs:element name="mobile" type="xs:string" />
<xs:element name="hetu" type="xs:string" />
<xs:element name="cn" type="xs:string" />
<xs:element name="organization" type="xs:string" />
<xs:element name="customattribute" type="customattribute-type"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="customattribute-type">
<xs:sequence>
<xs:element name="value" type="xs:string"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="optional" />
</xs:complexType>
<xs:complexType name="memberships-type">
<xs:choice>
<xs:sequence>
<xs:element name="id" type="xs:string"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
<xs:sequence>
<xs:element name="organization" type="organization-type"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:choice>
</xs:complexType>
<xs:complexType name="members-type">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="1"
maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="roles-type">
<xs:sequence>
<xs:element name="role" type="role-type"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="role-type">
<xs:sequence>
<xs:element name="id" type="xs:string" />
<xs:element name="roleassignments" type="roleassignments-type"
minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="roleassignments-type">
<xs:sequence>
<xs:element name="roleassignment" type="roleassignment-type"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="roleassignment-type">
<xs:choice>
<xs:element name="role" type="role-type" />
<xs:element name="userid" type="xs:string" />
<xs:element name="user" type="user-type" />
</xs:choice>
</xs:complexType>
<xs:complexType name="pendingOrganizations-type">
<xs:sequence>
<xs:element name="count" type="xs:string" />
<xs:element name="newest" type="xs:string" />
<xs:element name="oldest" type="xs:string" />
<xs:element name="url" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="groupassignments-type">
<xs:sequence>
<xs:element name="groupassignment" type="groupassignment-type"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="groupassignment-type">
<xs:sequence>
<xs:element name="group" type="group-type" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="group-type">
<xs:sequence>
<xs:element name="id" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="authentication-type">
<xs:sequence>
<xs:element name="password" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="sms.activated" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="otp.activated" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="otp.state" type="xs:string"
minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="idlist-type">
<xs:sequence>
<xs:element name="id" type="xs:string" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="entitylist-type">
<xs:sequence>
<xs:element ref="organization" minOccurs="0"
maxOccurs="unbounded" />
<xs:element ref="user" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="mandatelist-type">
<xs:sequence>
<xs:choice>
<xs:element ref="mandate" minOccurs="0"
maxOccurs="unbounded" />
<xs:element name="id" type="xs:string"
minOccurs="0" maxOccurs="unbounded" />
</xs:choice>
</xs:sequence>
</xs:complexType>
<xs:complexType name="error-type">
<xs:sequence>
<xs:element name="code" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="message" type="xs:string"
minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="delegations-type">
<xs:sequence>
<xs:element name="userid" type="xs:string"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="mandates-type">
<xs:sequence>
<xs:element name="mandate" type="mandate-type"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="mandate-type">
<xs:sequence>
<xs:element name="id" type="xs:string" />
<xs:element name="name" type="xs:string" />
<xs:element name="type" type="xs:string" />
<xs:element name="mandater" type="xs:string" />
<xs:element name="mandatee" type="xs:string" />
<xs:element name="roles" type="roles-type" />
<xs:element name="delegations" type="delegations-type" />
<xs:any namespace="##any" minOccurs="0" maxOccurs="unbounded"
processContents="skip" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="mandatetemplates-type">
<xs:sequence>
<xs:element name="mandatetemplate" type="mandatetemplate-type"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="mandatetemplate-type">
<xs:sequence>
<xs:element name="id" type="xs:string" />
<xs:element name="name" type="xs:string" />
<xs:element name="type" type="xs:string" />
<xs:element name="mandater" type="xs:string" />
<xs:element name="roles" type="roles-type" />
<xs:any namespace="##any" minOccurs="0" maxOccurs="unbounded"
processContents="skip" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="roleinvitation-type">
<xs:sequence>
<xs:element name="user" type="user-type"></xs:element>
<xs:element name="roles" type="roles-type"></xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="pendingUser-type">
<xs:sequence>
<xs:element name="userid" type="xs:string"></xs:element>
<xs:element name="pendinguserid" type="xs:string"></xs:element>
<xs:element name="registrationwf" type="xs:string"></xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X POST "https://localhost:7443/customerid-rest/services/mandates/?username=restuser&password=secret&mandateType=ORGTOORG&roles=6666666-6/TestRole&mandater=6666666-6&mandatee=7777777-7"
|
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME</id>
</idlist>
|
...
Curl Example
Code Block |
---|
|
curl --insecure -X PUT "https://localhost:7443/customerid-rest/services/mandate/7777777-7XXXXXXXXXXXXXXXXXXXX?username=restuser&password=secret&roles=6666666-6/TestRole2" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X PUT "https://localhost:7443/customerid-rest/services/delegations/7777777-7XXXXXXXXXXXXXXXXXXXX?username=restuser&password=secret&delegate=7777777-7/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X DELETE "https://localhost:7443/customerid-rest/services/delegations/7777777-7XXXXXXXXXXXXXXXXXXXX?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X PUT "https://localhost:7443/customerid-rest/services/roledelegations/7777777-7XXXXXXXXXXXXXXXXXXXX?username=restuser&password=secret&delegate=7777777-7/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&role=1234567-8/TestRole" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X DELETE "https://localhost:7443/customerid-rest/services/roledelegations/7777777-7XXXXXXXXXXXXXXXXXXXX?role=1234567-8/TestRole&username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X DELETE "https://localhost:7443/customerid-rest/services/mandate/7777777-7XXXXXXXXXXXXXXXXXXXX?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0"
encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME</id>
</idlist> |
...
Curl Examples
Code Block |
---|
|
curl --insecure -X POST "https://localhost:7443/customerid-rest/services/mandatetemplates/?username=restuser&password=secret&mandaterType=ORGTO&roles=6666666-6/TestRole&mandater=6666666-6&name=TestTemplate"
curl --insecure -X POST "https://localhost:7443/customerid-rest/services/mandatetemplates/?username=restuser&password=secret&mandaterType=PERTO&roles=6666666-6/TestRole&mandater=5555555-5/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&name=TestTemplate" |
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https <idlist>
<id>https://HOSTNAME/customerid-rest/services/mandatetemplate/MANDATETEMPLATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X PUT "https://localhost:7443/customerid-rest/services/mandatetemplate/TestTemplate?username=restuser&password=secret&name=TestTemplate2" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandatetemplate/MANDATETEMPLATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X POST "https://localhost:7443/customerid-rest/services/mandatetemplate/TestTemplate2?username=restuser&password=secret&mandatee=6666666-6&mandateeType=TOORG" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X DELETE "https://localhost:7443/customerid-rest/services/mandatetemplate/TestTemplate2?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandatetemplate/MANDATETEMPLATENAME</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X POST "https://localhost:7443/customerid-rest/services/roleinvitations/?username=restuser&password=secret&user=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&role=6666666-6/TestRole" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/roleinvitation/ROLEINVITATIONID</id>
</idlist> |
Or when roleinvite.receiver.approval = false
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<idlist>
<id>null</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X POST "https://localhost:7443/customerid-rest/services/pendingusers/?username=restuser&password=secret®istration=consumer&email=leena.laine@example.org" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/pendinguser/USERID</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/mandates/?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME1</id>
<id>https://HOSTNAME/customerid-rest/services/mandate/MANDATENAME2</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/mandate/7777777-7XXXXXXXXXXXXXXXXXXXX?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<mandate>
<mandate>
<id>https://HOSTNAME/customerid-rest/services/mandate/testmandate</id>
<name>Test Mandate</name>
<type>OrgToPer</type>
<mandater>https://HOSTNAME/eidm2/services/org1/</mandater>
<mandatee>https://HOSTNAME/eidm2/services/org1/org2/TestUser</mandatee>
<roles>
<role>
<id>https://HOSTNAME/eidm2/services/org1/org2/OrganizationMainUser</id>
</role>
<role>
<id>https://HOSTNAME/eidm2/services/role/org1/org2/OrganizationUser</id>
</role>
</roles>
<delegations>
<userid>https://HOSTNAME/eidm2/services/user/org1/org2/TestUser2</userid>
</delegations>
</mandate> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/mandatetemplates/?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<id>https://HOSTNAME/customerid-rest/services/mandatetemplate/MANDATETEMPLATENAME1</id>
<id>https://HOSTNAME/customerid-rest/services/mandatetemplate/MANDATETEMPLATENAME2</id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/mandatetemplate/XXXXXXXXXXXXXXXXXXXX?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<mandatetemplate>
<id>https://HOSTNAME/customerid-rest/services/mandatetemplates/mandatetemplate1</id>
<name>Test Mandate Template</name>
<type>OrgTo</type>
<mandater>https://HOSTNAME/eidm2/services/org1/</mandater>
<roles>
<role>
<id>https://HOSTNAME/eidm2/services/org1/org2/OrganizationMainUser</id>
</role>
<role>
<id>https://HOSTNAME/eidm2/services/org1/org2/OrganizationUser</id>
</role>
</roles>
</mandatetemplate> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/roleinvitations/6666666-6/?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<Id>https://HOSTNAME/customerid-rest/services/roleinvitation/ROLEINVITATIONID1</Id>
<Id>https://HOSTNAME/customerid-rest/services/roleinvitation/ROLEINVITATIONID2</Id>
<Id>https://HOSTNAME/customerid-rest/services/roleinvitation/ROLEINVITATIONID3</Id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/roleinvitation/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<roleinvitation> <roleinvitation>
<roles>
<role><Id>https://HOSTNAME/customerid-rest/services/role/ROLEID1</Id></Role>
</Roles>
<user><Id>https://HOSTNAME/customerid-rest/services/user/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY</Id></user>
</roleinvitation> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/pendingusers?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<Id>https://HOSTNAME/customerid-rest/services/pendinguser/USERID1</Id>
<Id>https://HOSTNAME/customerid-rest/services/pendinguser/USERID2</Id>
<Id>https://HOSTNAME/customerid-rest/services/pendinguser/USERID3</Id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/pendingusers/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<idlist>
<Id>https://HOSTNAME/customerid-rest/services/pendinguser/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY</Id>
</idlist> |
...
Curl Example
Code Block |
---|
|
curl --insecure -X GET "https://localhost:7443/customerid-rest/services/pendinguser/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?username=restuser&password=secret" |
...
Response Document
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<pendingUser>
<userid>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</userid>
<pendinguserid>YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY</pendinguserid>
<registrationwf>person</registrationwf>
</pendingUser> |
...