Domain (Identity System) Management API
{ http://soa.com/uri/products/domainadmin/wsdl/1.0 } DomainMgmtService
This API is used to manage PM security domains, or identity systems.
POST/domainsAdd a domain
Add a domain.
Request
POST /rest/domains HTTP/1.1
Content-Type: application/json
{
"DomainName" : "LDAP1",
"DomainDescription" : "My LDAP domain",
"IdentitySystemType" : "Directory Server",
"ModuleClassName" : "com.soa.security.provider.ldap.LDAPSecurityProvider",
"LastUpdatedDts" : "2015-12-09T02:40:25Z",
"ConnectorName" : "33c9d1fe-9e1e-11e5-ae49-c39bdb8021bb",
"ConnectorConfiguration" : "I0RvbWFpbiBwdXsZGFwLmdyb3VwLlRhcC5ihS5sZG29...",
"OrganizationScope" : "uddi:soa.com:registryorganization",
"SupportsInteractiveLogin" : true,
"SupportsWsLogin" : true,
"SupportsAuthorization" : false,
"SupportsIdentityBrowsing" : true,
"SupportsLoginProcess" : true
}
Response
HTTP/1.1 200 OK
{
"DomainName" : "LDAP1",
"DomainDescription" : "My LDAP domain",
"IdentitySystemType" : "Directory Server",
"ModuleClassName" : "com.soa.security.provider.ldap.LDAPSecurityProvider",
"LastUpdatedDts" : "2015-12-09T02:40:25Z",
"ConnectorName" : "33c9d1fe-9e1e-11e5-ae49-c39bdb8021bb",
"ConnectorConfiguration" : "I0RvbWFpbiBwdXsZGFwLmdyb3VwLlRhcC5ihS5sZG29...",
"OrganizationScope" : "uddi:soa.com:registryorganization",
"SupportsInteractiveLogin" : true,
"SupportsWsLogin" : true,
"SupportsAuthorization" : false,
"SupportsIdentityBrowsing" : true,
"SupportsLoginProcess" : true
}
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
body
entity
New domain information.
Domain
Domain {
DomainName( string, required )
IdentitySystemType( string, required )
SupportsInteractiveLogin( boolean )
SupportsAuthorization( boolean )
ConnectorConfiguration( base64Binary )
Sequence( int )
ModuleClassName( string, required )
OrganizationScope( string )
SupportsWsLogin( boolean )
ConnectorName( string )
SupportsIdentityBrowsing( boolean )
SupportsLoginProcess( boolean )
DomainDescription( string )
LastUpdatedDts( dateTime )
}
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
Domain
Domain {
DomainName( string )
IdentitySystemType( string )
SupportsInteractiveLogin( boolean )
SupportsAuthorization( boolean )
ConnectorConfiguration( base64Binary )
Sequence( int )
ModuleClassName( string )
OrganizationScope( string )
SupportsWsLogin( boolean )
ConnectorName( string )
SupportsIdentityBrowsing( boolean )
SupportsLoginProcess( boolean )
DomainDescription( string )
LastUpdatedDts( dateTime )
}
500
Internal error trying to create the domain
GET/domains/{domainName}Get domain details
Retrieves a domain's configuration.
Request
GET /rest/domains/Local%20Domain HTTP/1.1
Response
HTTP/1.1 200 OK
{
"DomainName" : "Local Domain",
"DomainDescription" : "Domain for local Policy Manager users",
"IdentitySystemType" : "Policy Manager",
"ModuleClassName" : "com.soa.security.provider.pm.PMSecurityModuleProvider",
"LastUpdatedDts" : "2015-12-09T02:40:25Z",
"SupportsInteractiveLogin" : true,
"SupportsWsLogin" : true,
"SupportsAuthorization" : true,
"SupportsIdentityBrowsing" : true,
"SupportsLoginProcess" : false
}
Parameters
Name
Type
Description
Model
domainName
path
Name of the domain.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
Domain
Domain {
DomainName( string )
IdentitySystemType( string )
SupportsInteractiveLogin( boolean )
SupportsAuthorization( boolean )
ConnectorConfiguration( base64Binary )
Sequence( int )
ModuleClassName( string )
OrganizationScope( string )
SupportsWsLogin( boolean )
ConnectorName( string )
SupportsIdentityBrowsing( boolean )
SupportsLoginProcess( boolean )
DomainDescription( string )
LastUpdatedDts( dateTime )
}
404
Specified domain not found (Invalid domain name)
500
Internal error trying to retrieve the domain
DELETE/domains/{domainName}Delete a domain
Delete a domain.
Request
DELETE /rest/domains/LDAP1 HTTP/1.1
Response
HTTP/1.1 200 OK
Parameters
Name
Type
Description
Model
domainName
path
Name of the domain.
string
Reponse
Status Code
Reason
Model
200
Success
404
Specified domain not found (Invalid domain name)
500
Internal error trying to delete the domain
POST/domains/{domainName}Modify a domain
Modify a domain.
Request
POST /rest/domains/LDAP1 HTTP/1.1
{
"DomainName" : "LDAP1",
"DomainDescription" : "My LDAP domain",
"IdentitySystemType" : "Directory Server",
"ModuleClassName" : "com.soa.security.provider.ldap.LDAPSecurityProvider",
"LastUpdatedDts" : "2015-12-09T02:40:25Z",
"ConnectorName" : "33c9d1fe-9e1e-11e5-ae49-c39bdb8021bb",
"ConnectorConfiguration" : "I0RvbWFpbiBwdXsZGFwLmdyb3VwLlRhcC5ihS5sZG29...",
"OrganizationScope" : "uddi:soa.com:registryorganization",
"SupportsInteractiveLogin" : true,
"SupportsWsLogin" : true,
"SupportsAuthorization" : false,
"SupportsIdentityBrowsing" : true,
"SupportsLoginProcess" : true
}
Response
HTTP/1.1 200 OK
{
"DomainName" : "LDAP1",
"DomainDescription" : "My LDAP domain",
"IdentitySystemType" : "Directory Server",
"ModuleClassName" : "com.soa.security.provider.ldap.LDAPSecurityProvider",
"LastUpdatedDts" : "2015-12-09T02:40:25Z",
"ConnectorName" : "33c9d1fe-9e1e-11e5-ae49-c39bdb8021bb",
"ConnectorConfiguration" : "I0RvbWFpbiBwdXsZGFwLmdyb3VwLlRhcC5ihS5sZG29...",
"OrganizationScope" : "uddi:soa.com:registryorganization",
"SupportsInteractiveLogin" : true,
"SupportsWsLogin" : true,
"SupportsAuthorization" : false,
"SupportsIdentityBrowsing" : true,
"SupportsLoginProcess" : true
}
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
domainName
path
Name of the domain.
string
body
entity
New domain information.
Domain
Domain {
DomainName( string, required )
IdentitySystemType( string, required )
SupportsInteractiveLogin( boolean )
SupportsAuthorization( boolean )
ConnectorConfiguration( base64Binary )
Sequence( int )
ModuleClassName( string, required )
OrganizationScope( string )
SupportsWsLogin( boolean )
ConnectorName( string )
SupportsIdentityBrowsing( boolean )
SupportsLoginProcess( boolean )
DomainDescription( string )
LastUpdatedDts( dateTime )
}
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
Domain
Domain {
DomainName( string )
IdentitySystemType( string )
SupportsInteractiveLogin( boolean )
SupportsAuthorization( boolean )
ConnectorConfiguration( base64Binary )
Sequence( int )
ModuleClassName( string )
OrganizationScope( string )
SupportsWsLogin( boolean )
ConnectorName( string )
SupportsIdentityBrowsing( boolean )
SupportsLoginProcess( boolean )
DomainDescription( string )
LastUpdatedDts( dateTime )
}
404
Specified domain not found (Invalid domain name)
500
Internal error retrieving the domain
