Create App Role
This API service provides the ability to securely create or remove App Roles.
POST Method
Resource URL
POST /campusm/v1/addons/ createAppRole
URL Parameters
None
Query string Parameters
Parameter | Type | Required | Description |
apiKey | xsd:string | Required | Supplied by Ex Libris as part of the implementation |
Body Parameters
Parameter | Type | Required | Description |
orgCode | xsd:int | Required | Supplied by Ex Libris as part of the implementation |
apiKey | xsd:string | Required | Supplied by Ex Libris as part of the implementation |
profile | xsd:string | Required | Defines the Profile to which the App Role will be added or removed |
description | xsd:string | Required | Defines the name of the Role to add to the user defined by the email address. |
priority | xsd:string | Optional | Defines the Role priority when listing the App Roles |
customerRole | xsd:string | Optional | Defined the Customer Role to attached to the created App Role. If no such customer role exists, a new one will be created |
delete | xsd:boolean | Optional | Define as “true” to delete the specified App Role |
Enter the parameters as a raw text in the body of the request such as the following text and fill in the fields with actual data:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm"> <soapenv:Header/> <soapenv:Body> <cam:createAppRoleRequest> <cam:orgCode><ORG CODES></cam:orgCode> <cam:apiKey><API KEY></cam:apiKey> <cam:appRoles> <cam:appRole> <cam:profile><PROFILE></cam:profile> <cam:description><APPROLE></cam:description> <cam:priority><PRIORITY></cam:priority> <cam:customerRole><CUSTOMERROLE></cam:customerRole> <cam:delete><BOOLEAN></cam:delete> </cam:appRole> </cam:appRoles> </cam:createAppRoleRequest> </soapenv:Body> </soapenv:Envelope>
Example
URL –
https://api-eu.hosted.exlibrisgroup.com/campusm/v1/addons/createAppRole?apiKey=<API KEY>
Body –
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm"> <soapenv:Header/> <soapenv:Body> <cam:createAppRoleRequest> <cam:orgCode>2222</cam:orgCode> <cam:apiKey>123546879</cam:apiKey> <cam:appRoles> <cam:appRole> <cam:profile>Test Profile</cam:profile> <cam:description>Test App Role</cam:description> <cam:priority>1</cam:priority> <cam:customerRole>Test Customer Role</cam:customerRole> <cam:delete>false</cam:delete> </cam:appRole> </cam:appRoles> </cam:createAppRoleRequest> </soapenv:Body> </soapenv:Envelope>
Output
This service returns a list of addAppRole Response object.
Description:
Field | Type | Description |
type | xsd:string | Indicated successful request |
desc | xsd:string | Identifies outcome of request, indicating which App Roles were added or removed |
timestamp | xsd:dateTime | Date:time request was processed |
Example
<?xml version='1.0' encoding='UTF-8'?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ns1:addAppRoleResponse xmlns:ns1="http://campusm.gw.com/campusm"> <ns1:type>S</ns1:type> <ns1:desc>Added Roles: Test App Role, </ns1:desc> <ns1:timestamp>2020-12-31T12:10:16.180+00:00</ns1:timestamp> </ns1:addAppRoleResponse> </soapenv:Body> </soapenv:Envelope>