Get Organization Details
get
/iam/governance/selfservice/api/v1/organizations/{orgid}
Returns the organization details specified by the organization id in the path parameter. 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, Parent Organization Name".
Request
Supported Media Types
- application/json
Path Parameters
-
orgid(required): string
Organization id
Query Parameters
-
fields: string
The attributes that are to be returned for 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 "/organization/{orgid}?fields=name, description.
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
Requested entity not found
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
This example retrieves an organization with the return fields filtered by organization Name and Parent Organization Name. 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/4?fields=Organization Name,Parent Organization Name"
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/organizations/4"
}
],
"id": 4,
"fields": [
{
"name": "Parent Organization Name",
"value": "Top"
},
{
"name": "Organization Name",
"value": "Org1"
}
]
}