Get Organization By Id Using GET
Get organization details.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Unique identifier (GUID) of the organization.
OK
{
"language": "string",
"displayName": "string",
"name": "string",
"maxAllowedAuthExemptedUserCount": 0,
"customerId": "string",
"refLink": "string",
"type": "string",
"parentRefLink": "string",
"locale": "string",
"trustedOrgs": [
{
"displayName": "string",
"id": "string",
"trustType": "string"
}
],
"enforceUserApiTokenMfa": false,
"trusteeOrgs": [
{
"displayName": "string",
"id": "string",
"trustType": "string"
}
],
"auditLogsInstanceId": "string",
"metadata": {
"metadata": "string"
},
"isMfaRequired": false,
"status": "string"
}Default locale lang code preference for the organization.
The display name of the organization.
Name or short unique identifier.
Maximum number of users allowed to be auth exempted in the Organization
The Broadcom ERP customer id
Document Ref Link of organization.
Type of the organization.
Document Ref Link of parent organization.
Default locale lang country preference for the organization.
List of details of trusted organizations.
Flag to enforce the user Api token multi-factor authentication (MFA).
If enabled then user needs to provide additional multi-factor authentication passcode when exchange API token for AccessToken.
Important:
Parameter enforceUserApiTokenMfa is no longer supported. Please use below mentioned APIs to manage MFA Api Token Policy.
POST /am/api/orgs/{orgId}/mfa-api-token-policy/activatePOST /am/api/orgs/{orgId}/mfa-api-token-policy/deactivateGET /am/api/orgs/{orgId}/mfa-api-token-policy
Note: Please use Authn sdk instead of AM sdk for MFA related Apis.
List of details of trustee organizations.
The instance of the LINT service in the region to which we will redirect audit logs. The organization must already have been granted access to the LINT service and assigned to one or more LINT service instances.
Metadata related to the organization.
If the flag is enabled, vmwid users will be able to login only when they enabled multi-factor authentication (MFA).
Important:
Parameter isMfaRequired is no longer supported. Please use below mentioned APIs to update MFA setting for an Org"
POST /am/api/orgs/{orgId}/mfa-policy/activatePOST /am/api/orgs/{orgId}/mfa-policy/deactivateGET /am/api/orgs/{orgId}/mfa-policy
Note: Please use Authn sdk instead of AM sdk for MFA related Apis.
Shows whether the organization is active/inactive.
The user is not authorized to use the API
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user is forbidden to use the API
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
Organization with this identifier is not found.
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user has sent too many requests
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}