Get User Roles


Get all roles that are assigned to a user.

Request Format


GET https://{apigw-address}/app-portal-service/v2.2/user/role/assignedList

Request Parameters (URI)


Name Mandatory/Optional Data Type Description
orgId Mandatory String The organization ID.
userId Mandatory String The user ID.
locale Optional String

The language code. If unspecified, it is set to English by default.

  • en_US for English
  • zh_CN for Chinese
  • es_ES for Spanish
  • ja_JP for Japanese
  • de_DE for German
  • pl_PL for Polish

Response Parameters


Name Data Type Description
data Data Struct The list of roles.

Data Struct


Name Data Type Description
roles RoleDTO Struct List The list of role structs.

RoleDTO Struct


Name Data Type Description
id String The role ID.
name String The role name.

Error Codes


Code Message Description
31400 Lack of necessary parameters OU ID or user ID is required.
31404 Can not find this organization The user or organization does not exist.

Samples

Request Sample


url: https://{apigw-address}/app-portal-service/v2.2/user/role/assignedList?orgId={your_org_id}&userId={your_user_id}

method: GET

Return Sample


{
    "code":0,
    "data":{
        "roles":[
          {
            "id":"your_role_id_1",
            "name":"your_role_name_1"
          },
          {
            "id":"your_role_id_2",
            "name":"your_role_name_2"
          }
        ]
    },
    "message":""
}