Get By Id
Read an organization.
Use this API instead:
- /cloudapi/1.0.0/orgs
Access Policy
| Role | Access |
|---|---|
| Platform operator | ✔️ |
| Organization Owner | ✔️ |
| Organization Member | ✔️ |
| Service Account (Whitelisted Client) | ✔️ |
Request
URI
GET
https://vcfa-10-162-161-9.vcfd.broadcom.net/csp/gateway/am/api/orgs/{orgId}
COPY
Path Parameters
string
orgId
Required
orgId
Responses
200
OK
Returns
OrganizationResponse
of type(s)
*/*
{
"name": "string",
"displayName": "string",
"metadata": {
"metadata": "string"
},
"id": "string",
"refLink": "string",
"parentRefLink": "string"
}
401
The user is not authorized to use the API.
Returns
OrganizationResponse
of type(s)
*/*
{
"name": "string",
"displayName": "string",
"metadata": {
"metadata": "string"
},
"id": "string",
"refLink": "string",
"parentRefLink": "string"
}
404
The organization is not found.
Returns
OrganizationResponse
of type(s)
*/*
"OrganizationResponse Object"
string
name
Optional
name
string
displayName
Optional
displayName
object
metadata
Optional
metadata
string
id
Optional
id
string
refLink
Optional
refLink
string
parentRefLink
Optional
parentRefLink
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}