You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 3
Next »
The following section guides you on invoking the admin service and describes the operations available in the WSO2 Identity Server Entitlement Service.
Invoking the admin service
EntitlementService
is an admin service of the WSO2 Carbon platform. As admin services are secured to prevent anonymous invocations, you cannot view the WSDL of the admin service by default. Follow the steps below to view and invoke it:
Set the <HideAdminServiceWSDLs>
element to false
in <IS_HOME>/repository/conf/carbon.xml
file.
<HideAdminServiceWSDLs>false</HideAdminServiceWSDLs>
- Restart the Identity Server.
- If you have started the server in default configurations, use the following URL in your browser to see the WSDL of the admin service:
https://localhost:9443/services/EntitlementService?wsdl
.
For more information on WSO2 admin services and how to invoke an admin service using either SoapUI or any other client program, see Calling Admin Services.
Operations included in the API
Get API resource list
Description | Get API resource list according to XACML 3.0 Specification |
---|
Resource Path | /home |
---|
HTTP Method | GET |
---|
Request/Response Format | application/json application/xml |
---|
Authentication | Basic |
---|
Username | admin |
---|
Password | admin |
---|
Parameters | Name | Located In | Description | Required | Schema |
---|
Accept | header | Request Media Type | Yes | string | Auth_Type | header | Authentication Type | Yes | string | Authorization | header | Add HTTP Basic Authorization | Yes | string | Content-type | header | Response Media Type | Yes | string |
|
---|
Response | |
---|
Evaluate XACML request
Description | Get response by evaluating JSON/XML XACML request |
---|
Resource Path | /pdp |
---|
HTTP Method | POST |
---|
Request/Response Format | application/json application/xml |
---|
Authentication | Basic |
---|
Username | admin |
---|
Password | admin |
---|
Parameters | Name | Located In | Description | Required | Schema |
---|
Accept | header | Request Media Type | Yes | string | Auth_Type | header | Authentication Type | Yes | string | Authorization | header | Add HTTP Basic Authorization | Yes | string | Content-type | header | Response Media Type | Yes | string | body | body | XACML JSON/XML Request | Yes | string |
|
---|
Response | Code | Description | Schema |
---|
200 | XACML JSON/XML Response |
| 40010 | Error in Response | ExceptionBean {
code:integer
message:string
} | 40020 | Request parse exception | ExceptionBean {
code:integer
message:string
} |
|
---|
Evaluate XACML request by attributes
Description | Get response by evaluating attributes |
---|
Resource Path | /by-attrib |
---|
HTTP Method | POST |
---|
Request/Response Format | application/json application/xml |
---|
Authentication | Basic |
---|
Username | admin |
---|
Password | admin |
---|
Parameters | Name | Located In | Description | Required | Schema |
---|
Accept | header | Request Media Type | Yes | string | Auth_Type | header | Authentication Type | Yes | string | Authorization | header | Add HTTP Basic Authorization | Yes | string | Content-type | header | Response Media Type | Yes | string | body | body | Decision Request Model | Yes | DecisionRequestModel {
subject:string
action:string
resource:string
environment:[
string
]
} |
|
---|
Response | Code | Description | Schema |
---|
200 | Method call success |
HomeResponseModel { }
| 40010 | Error in Response | ExceptionBean {
code:integer
message:string
} | 40020 | Request parse exception | ExceptionBean {
code:integer
message:string
} |
|
---|
Evaluate XACML request by attributes and receive boolean response
Description | Get boolean response by evaluating attributes |
---|
Resource Path | /by-attrib-boolean |
---|
HTTP Method | POST |
---|
Request/Response Format | application/json application/xml |
---|
Authentication | Basic |
---|
Username | admin |
---|
Password | admin |
---|
Parameters | Name | Located In | Description | Required | Schema |
---|
Accept | header | Request Media Type | Yes | string | Auth_Type | header | Authentication Type | Yes | string | Authorization | header | Add HTTP Basic Authorization | Yes | string | Content-type | header | Response Media Type | Yes | string | body | body | Decision Request Model | Yes | DecisionRequestModel {
subject:string
action:string
resource:string
environment:[
string
]
} |
|
---|
Response | Code | Description | Schema |
---|
200 | XACML JSON/XML Response |
| 40010 | Error in Response | ExceptionBean {
code:integer
message:string
} | 40020 | Request parse exception | ExceptionBean {
code:integer
message:string
} |
|
---|
Get entitled attributes
Description | Get entitled attributes for a given set of parameters. |
---|
Resource Path | /entitled-attribs |
---|
HTTP Method | POST |
---|
Request/Response Format | application/json application/xml |
---|
Authentication | Basic |
---|
Username | admin |
---|
Password | admin |
---|
Parameters | Name | Located In | Description | Required | Schema |
---|
Accept | header | Request Media Type | Yes | string | Auth_Type | header | Authentication Type | Yes | string | Authorization | header | Add HTTP Basic Authorization | Yes | string | Content-type | header | Response Media Type | Yes | string | body | body | Decision Request Model | Yes | EntitledAttributesRequestModel {
subjectName:string
resourceName:string
subjectId:string
action:string
enableChildSearch:boolean
} |
|
---|
Response | Code | Description | Schema |
---|
200 | Entitled attributes response | EntitledAttributesResponseModel {
entitledResultSetDTO:EntitledResultSetDTO {
entitledAttributesDTOs:[
EntitledAttributesDTO {
resourceName:string
action:string
environment:string
allActions:boolean
allResources:boolean
attributeDTOs:[
AttributeDTO {
attributeValue:string
attributeDataType:string
attributeId:string
category:string
}
]
}
]
advanceResult:boolean
message:string
messageType:string
}
} | 40010 | Error in Response | ExceptionBean {
code:integer
message:string
} | 40020 | Request parse exception | ExceptionBean {
code:integer
message:string
} |
|
---|
Get all entitlements
Description | Get all entitlements for a given set of parameters |
---|
Resource Path | /entitlements-all |
---|
HTTP Method | POST |
---|
Request/Response Format | application/json application/xml |
---|
Authentication | Basic |
---|
Username | admin |
---|
Password | admin |
---|
Parameters | Name | Located In | Description | Required | Schema |
---|
Accept | header | Request Media Type | Yes | string | Auth_Type | header | Authentication Type | Yes | string | Authorization | header | Add HTTP Basic Authorization | Yes | string | Content-type | header | Response Media Type | Yes | string | body | body | All Entitlements Model | Yes | AllEntitlementsRequestModel {
identifier:string
givenAttributes:[
AttributeDTO {
attributeValue:string
attributeDataType:string
attributeId:string
category:string
}
]
} |
|
---|
Response | Code | Description | Schema |
---|
200 | All entitlements response | AllEntitlementsResponseModel {
entitledResultSetDTO:EntitledResultSetDTO {
entitledAttributesDTOs:[
EntitledAttributesDTO {
resourceName:string
action:string
environment:string
allActions:boolean
allResources:boolean
attributeDTOs:[
AttributeDTO {
attributeValue:string
attributeDataType:string
attributeId:string
category:string
}
]
}
]
advanceResult:boolean
message:string
messageType:string
}
} | 40010 | Error in Response | ExceptionBean {
code:integer
message:string
} | 40020 | Request parse exception | ExceptionBean {
code:integer
message:string
} |
|
---|