GetOrganizationalUnit

Updated at:

Queries the information of an EIAM organizational unit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

Instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx

OrganizationalUnitId

string

Yes

Organizational unit ID.

ou_wovwffm62xifdziem7an7xxxxx

Response elements

Element

Type

Description

Example

object

Response result.

RequestId

string

Request ID.

0441BD79-92F3-53AA-8657-F8CE4A2B912A

OrganizationalUnit

object

Organizational unit data object.

OrganizationalUnitId

string

Organizational unit ID.

ou_wovwffm62xifdziem7an7xxxxx

OrganizationalUnitName

string

Organizational unit name.

test_organizationalUnit_name

ParentId

string

Parent organizational unit ID.

ou_wovwffm62xifdziem7an7xxxxx

OrganizationalUnitExternalId

string

Organizational unit external ID, used for mapping between external data and IDaaS organizational units. The default value is the IDaaS organizational unit ID.

Note: The external ID is unique within the same source type and source ID.

ou_wovwffm62xifdziem7an7xxxxx

OrganizationalUnitSourceType

string

Account source type. Valid values:

  • build_in: self-built.

  • ding_talk: imported from DingTalk.

  • ad: imported from AD.

  • ldap: imported from LDAP.

  • we_com: imported from WeCom.

build_in

OrganizationalUnitSourceId

string

Organizational unit source ID.

The default value for the self-built type is the instance ID. For other types, the value corresponds to the enterprise ID of the respective source. For example, the DingTalk source corresponds to the corpId of the DingTalk enterprise.

idaas_ue2jvisn35ea5lmthk267xxxxx

CreateTime

integer

The time when the organizational unit was created, in Unix timestamp format, in milliseconds.

1652085686179

UpdateTime

integer

The time when the organizational unit was last updated, in Unix timestamp format, in milliseconds.

1652085686179

Description

string

Description of the organizational unit.

Test organization

InstanceId

string

Instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx

Leaf

boolean

Indicates whether the organizational unit is a leaf node. A value of true indicates that the organizational unit has no child nodes, and a value of false indicates that the organizational unit has child nodes.

false

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "OrganizationalUnit": {
    "OrganizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
    "OrganizationalUnitName": "test_organizationalUnit_name",
    "ParentId": "ou_wovwffm62xifdziem7an7xxxxx",
    "OrganizationalUnitExternalId": "ou_wovwffm62xifdziem7an7xxxxx",
    "OrganizationalUnitSourceType": "build_in",
    "OrganizationalUnitSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "CreateTime": 1652085686179,
    "UpdateTime": 1652085686179,
    "Description": "Test organization",
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "Leaf": false
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.