Force Logout
This API service provides the ability to force users to be logged out, requiring them to reauthenticate when next they use campusM
POST Method
Resource URL
POST /campusm/v1/cmrest/forceLogout
URL Parameters
Parameter | Type | Description |
Org_code | xs:string | A unique org_code |
Query string Parameters
Parameter | Type | Required | Description |
all | xsd:boolean | Optional | True/False statement to apply to all users |
role | xsd:int | Optional | Comma-delimited list of role IDs |
xsd:string | Optional | Comma-delimited list of user emails |
Body Parameters
None
Example
URL –
https://api-eu.hosted.exlibrisgroup.com/campusm/v1/cmrest/forceLogout/<ORG_CODE>?apikey=<API KEY>&email=<EMAIL ADDRESS1>,<EMAIL ADDRESS2>
https://api-eu.hosted.exlibrisgroup.com/campusm/v1/cmrest/forceLogout/<ORG_CODE>?apikey=<API KEY>&role=<ROLE_ID1>,< ROLE_ID2>
Output
This service returns a JSON response.
Description:
Field | Type | Description |
succeed | Boolean | Indicated if the request was processed successfully |
count | Int | Indicated the number of users who will require to reauthenticate when next they use the app |
message | String | Output message |
Example
{ "succeed": true, "count": 126, "message": "Successfully forced 126 users in 2 profiles." }