Get Organization By Id Using GET

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 ✔️ ✔️
Request
URI
GET
https://{api_host}/csp/gateway/am/api/orgs/{orgId}
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns OrganizationDto of type(s) application/json 
{
    "auditLogsInstanceId": "string",
    "displayName": "string",
    "enforceUserApiTokenMfa": false,
    "isMfaRequired": false,
    "language": "string",
    "locale": "string",
    "maxAllowedAuthExemptedUserCount": 0,
    "metadata": {
        "metadata": "string"
    },
    "name": "string",
    "parentRefLink": "string",
    "refLink": "string",
    "status": "string",
    "trustedOrgs": [
        {
            "id": "string"
        }
    ],
    "type": "string"
}
string
auditLogsInstanceId
Optional

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.

string
displayName
Required

The display name of the organization.

boolean
enforceUserApiTokenMfa
Optional

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.

boolean
isMfaRequired
Optional

If the flag is enabled, vmwid users will be able to login only when they enabled multi-factor authentication (MFA).

string
language
Optional

Default locale lang code preference for the organization.

string
locale
Optional

Default locale lang country preference for the organization.

integer As int32 As int32
maxAllowedAuthExemptedUserCount
Optional

Maximum number of users allowed to be auth exempted in the Organization

object
metadata
Optional

Metadata related to the organization.

string
name
Optional

Name or short unique identifier.

string
parentRefLink
Optional

Document Ref Link of parent organization.

string
refLink
Optional

Document Ref Link of organization.

string
status
Optional

Shows whether the organization is active/inactive.

array of TrustedOrgInfoDto
trustedOrgs
Optional

The description about the trust.

string
type
Optional

Type of the organization.

Possible values are : PARTNER_MASTER, PARTNER_TENANT,

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


On This Page
Organization Operations
POST
Activate Organization Refresh Tokens Using POST
Deprecated
POST
Activate Organization Refresh Tokens With Api Token Path Using POST
POST
Assign Roles To Clients On Organization Using POST
POST
Create Trust Member Organization Using POST
POST
Deactivate Organization Refresh Tokens Using POST
Deprecated
POST
Deactivate Organization Refresh Tokens With Api Token Path Using POST
DELETE
Delete Organization Idp Registration Using DELETE
GET
Get Groups In Organizations By Organization Id And Group Search Term Using GET
GET
Get Organization By Id Using GET
GET
Get Organization Clients By Organization Id Using GET
GET
Get Organization Invitations By Organization Id Using GET
GET
Get Organization Roles By Organization Id Using GET
GET
Get Organization Users By Organization Id Using GET
GET
Get Org Linked Idp Details Using GET
GET
Get Sub Organizations By Organization Id Using GET
GET
Get Trust Member Organizations Using GET
GET
Get User Invitation By Organization Id And User Invitation Id Using GET
GET
Get Users In Organization By Organization Id And User Search Term Using GET
Deprecated
POST
Invite Users Using POST
POST
Link Org To Idp Using POST
DELETE
Remove Clients From Organization By Organization Id Using DELETE
DELETE
Remove Users From Organization By Organization Id Using DELETE
DELETE
Revoke User Invitation By Organization Id And User Invitation Id Using DELETE
POST
Search Organization Users By Organization Id And Roles Search Term Using POST
PATCH
Update Organization By Organization Id Using PATCH