All Products
Search
Document Center

Identity as a Service:GetOrganizationalUnit

Last Updated:Dec 17, 2024

Queries the information about an organizational unit in Identity as a Service (IDaaS) Employee IAM (EIAM).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eiam:GetOrganizationalUnitget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

idaas_ue2jvisn35ea5lmthk267xxxxx
OrganizationalUnitIdstringYes

The ID of the organizational unit.

ou_wovwffm62xifdziem7an7xxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response data.

RequestIdstring

The ID of the request.

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

The data object of the organizational unit.

OrganizationalUnitIdstring

The ID of the organizational unit.

ou_wovwffm62xifdziem7an7xxxxx
ParentIdstring

The ID of the parent organizational unit.

ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitExternalIdstring

The external ID of the organizational unit. The external ID can be used by external data to map the data of the organizational unit in IDaaS EIAM. By default, the external ID is the organizational unit ID.

For organizational units with the same source type and source ID, each organizational unit has a unique external ID.

ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitSourceTypestring

The source type of the organizational unit. Valid values:

  • build_in: The organizational unit was created in IDaaS.
  • ding_talk: The organizational unit was imported from DingTalk.
  • ad: The organizational unit was imported from Microsoft Active Directory (AD).
  • ldap: The organizational unit was imported from a Lightweight Directory Access Protocol (LDAP) service.
build_in
OrganizationalUnitSourceIdstring

The source ID of the organizational unit.

If the organizational unit was created in IDaaS, its source ID is the ID of the IDaaS instance. If the organizational unit was imported, its source ID is the enterprise ID in the source. For example, if the organizational unit was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.

idaas_ue2jvisn35ea5lmthk267xxxxx
CreateTimelong

The time when the organizational unit was created. This value is a UNIX timestamp. Unit: milliseconds.

1652085686179
UpdateTimelong

The time when the organizational unit was last updated. The value is a UNIX timestamp. Unit: milliseconds.

1652085686179
Descriptionstring

The description of the organizational unit.

Test organizational unit
InstanceIdstring

The ID of the instance.

idaas_ue2jvisn35ea5lmthk267xxxxx
Leafboolean

Indicates whether the node is a leaf node.

false

Examples

Sample success responses

JSONformat

{
  "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 organizational unit\n",
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "Leaf": false
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-04The response structure of the API has changedView Change Details
2023-03-21The response structure of the API has changedView Change Details