Get All Organizations
get
/iam/governance/selfservice/api/v1/organizations
Returns the organizations assigned to the logged in user. The filter query parameter can be used to return a subset of the organizations. SCIM filter is accepted. For example The query to get all organizations whose name starts with Oracle is "/organizations?q=Organization::Name sw Oracle". The attributes that are to be returned by the organization can also be controlled by specifying the attributes query parameter. A Comma-separated list of the attribute names is to be passed to the attribbutes query parameter. For example to get the organization name and description only the URI is "/organizations?fields=Organization Name, Organization Status".
Request
Supported Media Types
- application/json
Query Parameters
-
fields: string
The attributes that are to be returned by the organization can also be controlled by specifying the attributes query parameter. A Comma-separated list of the attribute names is to be passed to the attributes query parameter. For example to get the organization name and description only the URI is "/organizations?fields=Organization Name".
-
q: string
Filter can be applied for "entityType" for that possible value is - Role and "roleid" for that organizations is retrieved. here should not be any spaces for filter value. Sample value for filter is "entityType eq Role" or "entityType eq Role and roleid={roleId}".
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
404 Response
Resource not found
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
This example retrieves all organizations.. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/organizations
Example of GET Response Body
The following example shows the contents of the response body in JSON format.
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/organizations?
offset=1&limit=10"
},
{
"rel": "first",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/organizations?
offset=1&limit=10"
}
],
"count": 1,
"hasMore": false,
"totalResult": -1,
"organizations": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/organizations/1"
}
],
"id": "1",
"fields": [
{
"name": "Applicable Password Policy",
"value": 1
},
{
"name": "Parent Organization Name",
"value": "Top"
},
{
"name": "act_create",
"value": "2019-03-29T20:14:27Z"
},
{
"name": "Organization Name",
"value": "Xellerate Users"
},
{
"name": "parent_key",
"value": 3
},
{
"name": "act_createby",
"value": 1
},
{
"name": "Organization Status",
"value": "Active"
},
{
"name": "act_data_level",
"value": 1
},
{
"name": "act_updateby",
"value": 1
},
{
"name": "Organization Customer Type",
"value": "System"
},
{
"name": "act_update",
"value": "2019-03-29T20:14:27Z"
},
{
"name": "Enforce New Password Policy",
"value": "Yes"
}
]
}
]
}