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

ParameterTypeRequiredDescription
apiKeyxsd:stringRequiredSupplied by Ex Libris as part of the implementation

Body Parameters

ParameterTypeRequiredDescription
orgCodexsd:intRequiredSupplied by Ex Libris as part of the implementation
apiKeyxsd:stringRequiredSupplied by Ex Libris as part of the implementation
profilexsd:stringRequiredDefines the Profile to which the App Role will be added or removed
descriptionxsd:stringRequiredDefines the name of the Role to add to the user defined by the email address.
priorityxsd:stringOptionalDefines the Role priority when  listing the App Roles
customerRolexsd:stringOptionalDefined the Customer Role to attached to the created App Role. If no such customer role exists, a new one will be created
deletexsd:booleanOptionalDefine 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:

FieldTypeDescription
typexsd:stringIndicated successful request
descxsd:stringIdentifies outcome of request, indicating which App Roles were added or removed
timestampxsd:dateTimeDate: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>