GET/Users/{userId}

ユーザーを取得する

HTTP Request

GEThttps://www.worksapis.com/scim/v2/Users/{userId}

Path Parameters

ParameterTypeDescription
userId integer 

ユーザー ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}
長期トークンを参照してください。


required 

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

Schema URL


required 
id string 

ユーザー ID


readOnly : true 
externalId string 

SCIM クライアントで管理する ID


maxLength : 100 
userName string 

アカウント。メールアドレスと同じ。
localpart@domain 形式
localpart は以下に従う

  • 2 ～ 40 字の英字、数字、ドット (".")、ハイフン ("-")、アンダーバー ("_") のみ使用できる
  • 最初の文字には英字、数字のみ使用できる
  • ドット (".") は最初と最後、および連続 ("..") では使用できない

required
maxLength : 90 
name object (name) 

required 
displayName string 

表示名


readOnly : true 
nickName string 

ニックネーム

  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 100 
preferredLanguage string 

言語コード


Allowed values : ja-JP, ko-KR, en-US, zh-CN, zh-TW 
timezone string 

タイムゾーン


default : ドメインで指定されたタイムゾーン 
active boolean 

有効化状態

  • true : 使用中
  • false : 一時停止
    ユーザー作成時には true を指定する

default : true 
emails array (ScimUserEmail) 

メール情報

 
phoneNumbers array (ScimUserPhoneNumber) 

電話番号

 
ims array (ScimUserInstantMessage) 

メッセンジャー情報

 
urn:ietf:params:scim:schemas:extension:works:2.0:User object (urn:ietf:params:scim:schemas:extension:works:2.0:User) 
 
meta object (meta) 
 

name

PropertyTypeDescription
familyName stringnull 

姓

  • 姓、名を合わせて最大 80 字まで使用できる
  • 姓と名のいずれか 1 つは必須
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 80 
givenName stringnull 

名

  • 姓、名を合わせて最大 80 字まで使用できる
  • 姓と名のいずれか 1 つは必須
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 80 

ScimUserEmail

PropertyTypeDescription
type string 

メールアドレスのタイプ

  • alias : サブメールアドレス
  • other : 個人メールアドレス

required
Allowed values : alias, other 
primary boolean 

プライマリ


default : false 
value string 

メールアドレス

  • alias (サブメールアドレス)
    • 最大 90 字
    • localpart@domain 形式
    • localpart は以下に従う
      • 2 ～ 40 字の英字、数字、ドット (".")、ハイフン ("-")、アンダーバー ("_") のみ使用できる
      • 最初の文字には英字、数字のみ使用できる
      • ドット (".") は最初と最後、および連続 ("..") では使用できない
    • 最大 10 個まで指定できる
  • other (個人メールアドレス)
    • SSO を使用しない場合には必須
    • localpart@domain 形式
    • localpart は 64 字以下
    • domain は 253 字以下

required 

ScimUserPhoneNumber

PropertyTypeDescription
type string 

電話番号タイプ

  • work : 電話番号
  • mobile : 携帯電話番号

required
Allowed values : work, mobile 
primary boolean 

プライマリ


default : false 
value string 

電話番号


required
maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100} 

ScimUserInstantMessage

PropertyTypeDescription
type string 

メッセンジャータイプ


required
Allowed values : work 
primary boolean 

プライマリ


default : false 
value string 

SNS ID


required
minLength : 1
maxLength : 100 

urn:ietf:params:scim:schemas:extension:works:2.0:User

PropertyTypeDescription
userExternalKey stringnull 

ユーザー Externalkey
"%"、"\"、"#"、"/"、"?" の特殊文字は利用不可。


maxLength : 100 

meta

PropertyTypeDescription
resourceType string 

リソースタイプ


Allowed values : USER, GROUP 
created string 

作成日時

 
lastModified string 

最終更新日時

 
location string 

リソース URI

 

HTTP 404

Not Found