Organization Management API
{ urn:com.soa.rest.services.orgmgmt } OrgMgmtREST
This API is used to manage PM organizations.
POST/organizationsAdd a new Organization
Add a new Organization under a given parent.
For brevity, the following Request creates an Organization with minimal parameters.
Can add Organization Contact, corresponding email, phone and address and also any
Operational/QoS/Compliance policies using this request.
Request :
POST /rest/organizations HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ParentKey": "uddi:soa.com:registryorganization",
"Name": "New Organization ",
"Description": "This is a new org ",
"Url": "http://local:80",
"OrganizationType": "Application",
"OrganizationContact": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name": "New Org Adding Contact",
"Description": "",
"UseType": "Official",
"OrganizationContactEmail": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Email": "x@y.com",
"UseType": "Personal"
}],
"OrganizationContactPhone": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Phone": "9999999999",
"UseType": "Personal"
}],
"OrganizationContactAddress": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"UseType": "Personal",
"Address1": "Address Line 1",
"Address2": "Address Line 2",
"Address3": "Address Line 3",
"Address4": "Address Line 4",
"Address5": "Address Line 5"
}]
}]
}
Response:
{
"OrganizationKey" : "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ParentKey" : "uddi:soa.com:registryorganization",
"Name" : "New Organization",
"Description" : "This is a new org",
"OrganizationType" : "Application",
"OperationalPolicyAttachment" : [ ],
"QoSPolicyAttachment" : [ ],
"CompliancePolicyAttachment" : [ ]
}
Parameters
PolicyAttachmentType {
Category {
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
atomLink {
Reponse
DELETE/organizations/{orgKey}Delete Organization
Delete Organization for a given key
Request :
DELETE /rest/organizations/{orgKey} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
GET/organizations/{orgKey}Get organization
Get details of organization based on given organization key
Request :
GET /rest/organizations/{orgKey} HTTP/1.1
Response:
{
"OrganizationKey": "uddi:5b7972c3-3bc5-11e5-82f4-850713ba2d72",
"ParentKey": "uddi:soa.com:registryorganization",
"Name": "My Org",
"Description": "",
"OrganizationType": "Application",
"OperationalPolicyAttachment": [],
"QoSPolicyAttachment": [],
"CompliancePolicyAttachment": []
}
Parameters
Reponse
PolicyAttachmentType {
Category {
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
atomLink {
PUT/organizations/{orgKey}Modify Organization with Given Key
Modify Organization with given key
Request : For brevity not included Org Contact, Policies etc.
PUT /rest/organizations/{orgKey} HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ParentKey": "uddi:soa.com:registryorganization",
"Name": "New Organization Modified",
"Description": "This is a new org Modified",
"Url": "http://local:80",
"OrganizationType": "Application"
}
Response:
HTTP/1.1 204 No Content
Parameters
PolicyAttachmentType {
Category {
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
atomLink {
POST/organizations/{orgKey}/contactsAdd a new organization contact
Add a new organizational contact along with given details like phone, email and address etc.
Request :
POST /rest/organizations/{orgKey}/contacts/ HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name": "New Org Adding Contact",
"Description": "",
"UseType": "Official",
"OrganizationContactEmail": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Email": "x@y.com",
"UseType": "Personal"
}],
"OrganizationContactPhone": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Phone": "9999999999",
"UseType": "Personal"
}],
"OrganizationContactAddress": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"UseType": "Personal",
"Address1": "Address Line 1",
"Address2": "Address Line 2",
"Address3": "Address Line 3",
"Address4": "Address Line 4",
"Address5": "Address Line 5"
}]
}
Response:HTTP/1.1 204 No Content
Parameters
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
GET/organizations/{orgKey}/contactsGet organizational contacts
Get all organizational contacts for a given organization based on org key
Request :
GET /rest/organizations/{orgKey}/contacts/{useType} HTTP/1.1
Response:
{"OrganizationContact": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name": "New Org Adding Contact",
"Description": "",
"UseType": "Official",
"OrganizationContactEmail": [ {
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Email": "x@y.com",
"UseType": "Personal"
}],
"OrganizationContactPhone": [ {
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Phone": "9999999999",
"UseType": "Personal"
}],
"OrganizationContactAddress": [ {
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"UseType": "Personal",
"Address1": "Address Line 1",
"Address2": "Address Line 2",
"Address3": "Address Line 3",
"Address4": "Address Line 4",
"Address5": "Address Line 5"
}]
}]}
Parameters
Reponse
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
POST/organizations/{orgKey}/identitiesAssign Identity to a given organization
Assign Identity to a given organization
Request :
POST /rest/organizations/{orgKey}/identities HTTP/1.1
HTTP/1.1 204 No Content
}
Parameters
GET/organizations/{orgKey}/childrenGet organization children
Get child organizations of an organization.
Parameters
Reponse
Organizations {}
atomLink {
DELETE/organizations/{orgKey}/contacts/{useType}Delete organizational contact
Delete a given organizational contact based on given org key and contact use type
Request :
DELETE /rest/organizations/{orgKey}/contacts/{useType} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
GET/organizations/{orgKey}/contacts/{useType}Get organizational contact
Get organizational contact information based on given org key and use type
Request :
GET /rest/organizations/{orgKey}/contacts/{useType} HTTP/1.1
Response:
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name": "New Org Adding Contact",
"Description": "",
"UseType": "Official",
"OrganizationContactEmail": [ {
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Email": "x@y.com",
"UseType": "Personal"
}],
"OrganizationContactPhone": [ {
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Phone": "9999999999",
"UseType": "Personal"
}],
"OrganizationContactAddress": [ {
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"UseType": "Personal",
"Address1": "Address Line 1",
"Address2": "Address Line 2",
"Address3": "Address Line 3",
"Address4": "Address Line 4",
"Address5": "Address Line 5"
}]
}
Parameters
Reponse
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
POST/organizations/{orgKey}/policies/operationalAttach operational policy to given org
Attach operational policy to a given orgaznizaion using given policy info
Request :
POST /rest/ organizations/{orgKey}/policies/operational HTTP/1.1
{
"OrganizationKey" : "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName" : "DetailedAuditing"
}
Response:
HTTP/1.1 204 No Content
Parameters
Category {
GET/organizations/{orgKey}/policies/operationalGet operational policy information
Get operational policy info based on given org key
Request :
GET /rest/organizations/{orgKey}/policies/operational HTTP/1.1
Response:
{"PolicyAttachment": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName": "DetailedAuditing"
}]}
Parameters
Reponse
PolicyAttachmentType {
Category {
POST/organizations/{orgKey}/policies/qosAttach QoS policy to given org
Attach QoS policy to a given orgaznizaion using given policy info
Request :
POST /rest/ organizations/{orgKey}/policies/qos HTTP/1.1
{
"OrganizationKey" : "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName" : "urn:uuid:20bb5fdd-3f12-11e5-ae8d-df99efc65381"
}
Response:
HTTP/1.1 204 No Content
Parameters
Category {
GET/organizations/{orgKey}/policies/qosGet QoS policy information
Get QoS policy info based on given org key
Request :
GET /rest/organizations/{orgKey}/policies/qos HTTP/1.1
Response:
{"PolicyAttachment": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName": "urn:uuid:20bb5fdd-3f12-11e5-ae8d-df99efc65381"
}]}
Parameters
Reponse
PolicyAttachmentType {
Category {
POST/organizations/{orgKey}/policies/complianceAttach Compliance policy to given org
Attach Compliance policy to a given orgaznizaion using given policy info
Request :
POST /rest/ organizations/{orgKey}/policies/compliance HTTP/1.1
{
"OrganizationKey" : "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName" : "urn:uuid:20bb5fdd-3f12-11e5-ae8d-df99efc65381"
}
Response:
HTTP/1.1 204 No Content
Parameters
Category {
GET/organizations/{orgKey}/policies/complianceGet Compliance policy information
Get Compliance policy info based on given org key
Request :
GET /rest/organizations/{orgKey}/policies/compliance HTTP/1.1
Response:
{"PolicyAttachment": [{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName": "urn:uuid:20bb5fdd-3f12-11e5-ae8d-df99efc65381"
}]}
Parameters
Reponse
PolicyAttachmentType {
Category {
DELETE/organizations/{orgKey}/identities/{qualifiedUserName}Un-Assign Identity to a given organization
Un-Assign Identity to a given organization
Request :
DELETE /rest/organizations/{orgKey}/identities/{qualifiedUserName} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
PUT/organizations/{orgKey}/contacts/{useType}Modify Organizational contact
Modify organizational contact based on given key and use type.
Request :
PUT /rest/organizations/{orgKey}/contacts/{useType} HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name": "New Org Modifying Contact",
"Description": "Modified Description",
"UseType": "Official"
}
Response:HTTP/1.1 204 No Content
Parameters
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
POST/organizations/{orgKey}/contacts/{contactUseType}/addressesAdd an address for a given org contact
Add address information for a given org contact based on org key and contact use type
Request :
POST /rest/organizations/{orgKey}/contacts/{useType}/addresses HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"UseType": "Personal",
"Address1": "Address Line 1",
"Address2": "Address Line 2",
"Address3": "Address Line 3",
"Address4": "Address Line 4",
"Address5": "Address Line 5"
}
Response:
HTTP/1.1 204 No Content
Parameters
POST/organizations/{orgKey}/contacts/{useType}/emailAdd email address to a given organizational contact
Add email addresses for a given organizational contact based on org key and use type
Request :
POST /rest/organizations/{orgKey}/contacts/{useType}/email HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"Email": "a@b.com",
"UseType": "Personal"
}
Response:
HTTP/1.1 204 No Content
Parameters
POST/organizations/{orgKey}/contacts/{contactUseType}/phonesAdd a phone number for a given org contact
Add phone information for a given org contact based on org key and contact use type
Request :
POST /rest/organizations/{orgKey}/contacts/{useType}/phones HTTP/1.1
{
"Phone": "9999999999",
"UseType":"Personal"
}
Response:
HTTP/1.1 204 No Content
Parameters
DELETE/organizations/{orgKey}/policies/operational/{policyName}Detach operational policy to given org
Detach operational policy to a given orgaznizaion using given policy info
Request :
DELETE /rest/organizations/{orgKey}/policies/operational/{policyName} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
DELETE/organizations/{orgKey}/policies/qos/{policyName}Detach QoS policy to given org
Detach QoS policy to a given orgaznizaion using given policy info
Request :
DELETE /rest/organizations/{orgKey}/policies/qos/{policyName} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
DELETE/organizations/{orgKey}/policies/compliance/{policyName}Detach Compliance policy to given org
Detach Compliance policy to a given orgaznizaion using given policy info
Request :
DELETE /rest/organizations/{orgKey}/policies/compliance/{policyName} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
PUT/organizations/{orgKey}/identities/{qualifiedUserName}/keystoreLoad Identity using PKI Data
Load Identity using PKI Data
Request :
PUT /rest/organizations/{orgKey}/identities/{qualifiedUserName}/keystore HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"QualifiedUserName": "a",
"KeyStoreInfo": {
"Location": "",
"Store": "",
"Type": "",
"Password": "",
"Alias": "",
"AliasPassword": ""
}
}
Response:
HTTP/1.1 204 No Content
Parameters
KeyStoreInfo {
PUT/organizations/{orgKey}/contacts/{contactUseType}/phones/{useType}Modify a phone number for a given org contact
Modify phone information for a given org contact based on org key and contact use type and phone use type
Request :
PUT /rest/organizations/{orgKey}/contacts/{contactUseType}/phones/{useType} HTTP/1.1
{
"Phone": "2222222222"
}
Response:
HTTP/1.1 204 No Content
Parameters
DELETE/organizations/{orgKey}/contacts/{contactUseType}/phones/{useType}Delete a phone number for a given org contact
Delete phone information for a given org contact based on org key and contact use type and phone use type
Request :
DELETE /rest/organizations/{orgKey}/contacts/{contactUseType}/phones/{useType} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
DELETE/organizations/{orgKey}/contacts/{contactUseType}/email/{useType}Delete email address of a given organization contact
Delete email address of a given org contact based on org key, contact use type and use type
Request :
DELETE /rest/organizations/{orgKey}/contacts/{contactUseType}/email/{useType} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
PUT/organizations/{orgKey}/contacts/{contactUseType}/email/{useType}Modify email address of a given contact
Modify email address of a given contact based on org key, contact use type and email use type
Request :
PUT /rest/organizations/{orgKey}/contacts/{contactUseType}/email/{useType} HTTP/1.1
{
"Email": "mmm@nnn.com"
}
Response:
HTTP/1.1 204 No Content
Parameters
PUT/organizations/{orgKey}/contacts/{contactUseType}/addresses/{useType}Modify a address info for a given org contact
Modify address information for a given org contact based on org key and contact use type and phone use type
Request :
PUT /rest/organizations/{orgKey}/contacts/{contactUseType}/addresses/{useType} HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType": "Official",
"UseType": "Personal",
"Address1": "Address Line 1",
"Address2": "Address Line 2",
"Address3": "Address Line 3",
"Address4": "Address Line 4",
"Address5": "Address Line 5"
}
Response:
HTTP/1.1 204 No Content
Parameters
DELETE/organizations/{orgKey}/contacts/{contactUseType}/addresses/{useType}Delete an address info for a given org contact
Delete address information for a given org contact based on org key and contact use type and phone use type
Request :
DELETE /rest/organizations/{orgKey}/contacts/{contactUseType}/addresses/{useType} HTTP/1.1
Response:
HTTP/1.1 204 No Content