GET/directory/user-types

利用権限タイプリストを取得する。

  • ドメインの利用権限タイプ設定が有効である必要がある。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/user-types

Query Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID (既定値: 認可ドメイン ID)


example : 10000001
format : int32 
count integer 

取得数


default : 100
minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
userTypes array (UserType) 

利用権限タイプ情報

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

UserType

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
userTypeId string 

利用権限タイプ ID

  • 利用権限タイプのリソース ID
  • 登録時に自動発行されるユニーク ID

readOnly : true 
displayOrder integer 

表示順位 (重複許可)


required
format : int32 
userTypeName string 

利用権限タイプ名
ドメイン内で一意
許容される特殊文字: !@&()-_+[]{},./


required
maxLength : 100 
userTypeExternalKey string 

利用権限タイプの ExternalKey
テナント内で一意になること
利用できない特殊文字: %#/?


maxLength : 100
nullable : true 
i18nNames array (I18nName) 

多国語名リスト
[管理者画面 > 基本設定 > 会社情報 > 多国語設定] で指定された項目の多国語のみ表示される。

 
userTypeCode string 

利用権限タイプコード
英字 (A ~ Z、a ~ z)、数字 (0 ~ 9)、underscore (_) が利用でき、最大 50 文字まで指定できる。
英字で始めなければならない。


maxLength : 50
nullable : true 

I18nName

PropertyTypeDescription
name string 

多国語表示名


required
minLength : 1
maxLength : 100 
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "userTypes": [3    {4      "domainId": 10000001,5      "userTypeId": "employ2c-f321-47a6-ac11-e81fcc23a8c3",6      "displayOrder": 1,7      "userTypeName": "利用権限タイプ01",8      "userTypeExternalKey": "USERTYPE_EXT_01",9      "i18nNames": [10        {11          "name": "English Name",12          "language": "en_US"13        }14      ],15      "userTypeCode": "code"16    },17    {18      "domainId": 10000001,19      "userTypeId": "employ0f-997b-4f47-9267-463f15e908a3",20      "displayOrder": 1,21      "userTypeName": "利用権限タイプ02",22      "userTypeExternalKey": "USERTYPE_EXT_02",23      "i18nNames": [24        {25          "name": "English Name",26          "language": "en_US"27        }28      ],29      "userTypeCode": "code"30    }31  ],32  "responseMetaData": {33    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="34  }35}

HTTP 403

Forbidden