orgInformation API

Use this API to get an organization's credentials.

Base URL

https://<host>:<port>/csa/rest

Details

URI /orgInformation/<organization name>
Method GET
Parameters

userIdentifier=<user_id>

Required; the user ID that you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

The user identified by userIdentifier must have admin access.
Returns 200 - Ok
401 - Not authorized
404 - Not found
500 - Server exception

Example

The following URL was sent:

https://<host>:<port>/csa/rest/orgInformation/my_organization

The following XML was returned in the response:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Organization>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <description>My Organization</description>
    <name>my_organization</name>
    <disabled>false</disabled>
</Organization>