Get User Permissions


Get the permissions that are assigned to a user for the current application.

Request Format


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

Request Parameters (URI)


Name

Mandatory/Optional

Data Type

Description

orgId

Mandatory

String

Organization ID.

userId

Mandatory

String

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 permissions.

Data Struct


Name

Data Type

Description

permissions

PermissionDTO Struct List

The list of permissions.

PermissionDTO Struct


Name

Data Type

Description

id

String

The permission ID.

name

String

The permission name.

Error Codes


Code

Description

31403

The user does not have the permission of the application.

31404

The user or organization does not exist.

Samples

Request Sample


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

method: GET

Return Sample


{
    "code":0,
    "data":{
        "permissions":[
          {
            "id":"your_app_id_1",
            "name":"your_app_name_1"
          },
          {
            "id":"your_app_id_2",
            "name":"your_app_name_2"
          }
        ]
    },
    "message":""
}