Allowed Domains

The user can use REST service APIs to add/retrieve/modify/remove the allowed domains in the ASALLOWEDDOMIN table. The ASALLOWEDDOMIN table contains the list of valid domains (secured external links) which can be configured in the DeepLinks or ExternalLinks business rule that are used to access the third party applications from OIPA.

Allowed Domains Service APIs

The following CRUD REST services can be used to Add/Retrieve/Modify/Remove a allowed domain in the 'ASALLOWEDDOMAIN' table.

This service adds a new domain in the ASALLOWEDDOMAIN table.

Method:POST

URI: /PASService/rest/services/url/domains/

Payload Parameters

Parameter Description (Mandatory/Optional)
domainName Mandatory

Sample Payload

{
"domains":
[
    {
      "domainName": " "
    },
    {
      "domainName": " "
    }
]
}
 
 

Expected Status Code

201- Created

 

This service modifies/updates the details of a specified domain in the ASALLOWEDDOMAIN table.

Method:PUT

URI: /PASService/rest/services/url/domains/id

Payload Parameters

Parameter Description (Mandatory/Optional)
domain Mandatory
domainName Mandatory

Sample Payload

{
"domains":
[
    {
      "domain": " "
    },
    {
      "domainName": " "
    }
]
}
 
 

Expected Status Code

204- Success

 

This service returns the list of all domains.

Method:GET

URI: /PASService/rest/services/url/domains

Sample Response

"{
        "count": 40,
        "offset": 0,
        "limit”:100
        {
           "links": [
                {
                    "href": "http://server:port/PASService/rest/services/url/domains/2C3D7F85-8B29-46D3-A978-F1262798729D",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                }
          ],
           "domainId": 
           "domainName": 
           "creationDate":
           "createdBy":
           "lastmodifiedby":
           "lastmodifiedGM"T:
           "status":
        },
        {
           "links": [
                {
                    "href": "http://server:port/PASService/rest/services/url/domains/2C3D7F85-8B29-46D3-A978-F1262798729D",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                }
          ],
          "domainId": 
          "domainName":    
          "creationDate":
          "createdBy":
          "lastmodifiedby":
          "lastmodifiedGMT":
          "status":
                  }   
      }”
 
 

Expected Status Code

200- Success

 

This service returns the details of a specified domain id.

Method:GET

URI: /PASService/rest/services/url/domains/id

Sample Response

"{
        "count": 1,
        "offset": 0,
        "limit”:100
        {
           "links": [
                {
                    "href": "http://server:port/PASService/rest/services/url/domains/2C3D7F85-8B29-46D3-A978-F1262798729D",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                }
          ],
           "domainId": 
           "domainName": 
           "creationDate":
           "createdBy":
           "lastmodifiedby":
           "lastmodifiedGM"T:
           "status":
        } 
}”
 
 

Expected Status Code

200- Success

 

This service returns the details of a specified domain name.

Method:GET

URI: PASService/rest/services/url/domains?q=domainName eq "oracle.com"

Sample Response

"{
        "count": 1,
        "offset": 0,
        "limit”:100
        {
           "links": [
                {
                    "href": "http://server:port/PASService/rest/services/url/domains/2C3D7F85-8B29-46D3-A978-F1262798729D",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                }
          ],
           "domainId": 
           "domainName": 
           "creationDate":
           "createdBy":
           "lastmodifiedby":
           "lastmodifiedGMT":
           "status":
        }
}"
 
 

Expected Status Code

200- Success

 

This service deletes a specified domain id.

Method: DELETE

URI: /PASService/rest/services/url/domains/{id}

 

Expected Status Code

200- Success