Get Organization User Group List¶

Get all user groups in an OU

Request Format¶

GET https://{apigw-address}/app-portal-service/v2.3/organization/userGroup/list

Request Parameters (URI)¶

Name

Mandatory/Optional

Data Type

Description

orgId

Mandatory

String

OU ID

locale

Optional

String

Language code. Enligh as default

en_US for English

zh_CN for Simplified Chinese

es_ES for Spanish

ja_JP for Japanese

Response Parameters¶

Name	Data Type	Description
userGroups	userGroup Struct	List of user groups

UserGroup Struct¶

Name	Data Type	Description
id	String	User group ID
name	String	User group name

Error Codes¶

Code	Description
31400	OU ID is required, or the application is invalid

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.3/organization/userGroup/list?orgId=o1630491651xxxxxxx&locale=en_US

method: GET

Return Sample¶

{
    "code": 0,
    "message": "OK",
    "data": {
        "userGroups": [
            {
                "name": "llm_test",
                "id": "ug16449085768461906"
            }
        ]
    }
}