OrganizationDto

OrganizationDto
OrganizationDto

Defines the properties of the organization.

JSON Example 
{
    "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"
}
string
language
Optional

Default locale lang code preference for the organization.

string
displayName
Required
Constraints: minLength: 0 maxLength: 200

The display name of the organization.

string
name
Optional

Name or short unique identifier.

integer As int32 As int32
maxAllowedAuthExemptedUserCount
Optional

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

string
customerId
Optional

The Broadcom ERP customer id

string
refLink
Optional

Document Ref Link of organization.

string
type
Optional

Type of the organization.

Possible values are : PARTNER_MASTER, PARTNER_TENANT, PARTNER,
string
parentRefLink
Optional

Document Ref Link of parent organization.

string
locale
Optional

Default locale lang country preference for the organization.

array of TrustOrgInfoDto
trustedOrgs
Optional

List of details of trusted organizations.

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.
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/activate
  • POST /am/api/orgs/{orgId}/mfa-api-token-policy/deactivate
  • GET  /am/api/orgs/{orgId}/mfa-api-token-policy

Note: Please use Authn sdk instead of AM sdk for MFA related Apis.

array of TrustOrgInfoDto
trusteeOrgs
Optional

List of details of trustee organizations.

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.

object
metadata
Optional

Metadata related to the organization.

boolean
isMfaRequired
Optional

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/activate
  • POST /am/api/orgs/{orgId}/mfa-policy/deactivate
  • GET  /am/api/orgs/{orgId}/mfa-policy

Note: Please use Authn sdk instead of AM sdk for MFA related Apis.

string
status
Optional

Shows whether the organization is active/inactive.

Property Of
Returned By