IIJ IDサービス APIリファレンス

ユーザ属性

基本属性

SCIMプロトコルで定義される基本的な属性です。

属性必須読み取り専用型デフォルト設定例説明
id○○文字列（String）  UUID
externalId  文字列（String） abc01234-12ab-12ab-0123-456abc外部 ID
meta      メタデータ
resourceType ○文字列（String）  リソースタイプ
created ○文字列（String）  作成日時
lastModified ○文字列（String）  更新日時
location ○文字列（String）  リソースを示すURI
userName○ 文字列（String） iij-taro@example.jp

ログインID
ユーザ作成後にログインIDは変更できません

name      氏名
familyName  文字列（String） iij氏名（姓）
givenName  文字列（String） taro氏名（名）
displayName ○文字列（String）  氏名
title  文字列（String） title役職
preferredLanguage  文字列（String）ja-JPja-JP

言語

入力可能な値は以下のおとりです

  • ja-JP
  • en-US
timezone  文字列（String）Asia/TokyoAsia/Tokyo

タイムゾーン

入力可能な値は以下のとおりです

  • Asia/Tokyo
active ○真偽値（Boolean）truetrueユーザの有効/無効を指定
password  文字列（String） user_password

パスワード

空文字は指定できません

emails  ○配列（Multi-valued）  

通知先メールアドレス

  • 最大5個まで指定できます
  • いずれかの通知先メールアドレスがプライマリである必要があります
value  文字列（String） iij-taro@example.jp通知先メールアドレス
primary  真偽値（Boolean） trueこのメールアドレスがプライマリの場合指定
groups  ○配列（Multi-valued）  所属しているグループ
value ○文字列（String）  所属しているグループのID
$ref ○文字列（String）  所属しているグループのURI
display ○文字列（String）  所属しているグループの名前
phoneNumbers   配列（Multi-valued）  

電話番号
最大 10 個まで指定できます

value  文字列（String） tel:+81-12-3456-7890電話番号の値 (RFC3966 形式)
display  文字列（String） 携帯電話電話番号の表示名
type  文字列（String） mobile電話番号のタイプ
primary  真偽値（Boolean） trueこの電話番号がプライマリの場合指定
ims   配列（Multi-valued）  

インスタントメッセンジャー

最大 10 個まで指定できます

value  文字列（String） iij-taro@example.jpインスタントメッセンジャーの値
display  文字列（String） メッセンジャー Aインスタントメッセンジャーの表示名
type  文字列（String） XMPPインスタントメッセンジャーのタイプ
primary  真偽値（Boolean） trueこのインスタントメッセンジャーがプライマリの場合指定
entitlements   配列（Multi-valued）  

entitlement

最大 20 個まで指定できます

value  文字列（String） entitlement_valueentitlement の値
display  文字列（String） entitlement_displayentitlement の表示名
type  文字列（String） entitlement_typeentitlement のタイプ
primary  真偽値（Boolean） trueこの entitlement がプライマリの場合指定
x509Certificates   配列（Multi-valued）  

X.509証明書

最大 20 個まで指定できます

value  文字列（String）  X.509証明書の値（Base64 エンコードされた DER 形式）
display  文字列（String）  X.509証明書の表示名
type  文字列（String）  X.509証明書のタイプ
primary  真偽値（Boolean）  この X.509 証明書がプライマリの場合指定
拡張属性（urn:ietf:params:scim:schemas:extension:enterprise:2.0:User）

企業向けの属性を表現するための拡張属性です。

属性必須読み取り専用型デフォルト設定例説明
organization ○文字列（String）  ドメインの組織名
department  文字列（String） Sales department所属
ユーザ拡張属性（urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User）

多言語表現を定義するためのEIWG拡張属性です。

属性必須読み取り専用型デフォルト設定例説明
localNames   配列（Multi-valued）  

氏名のよみがな

localeがja-JPの場合、読み取り専用

locale  文字列（String） ja-Hira-JP

氏名の言語

typeと一致させる必要があります

入力可能な値は以下です

  • ja-JP
  • ja-Hira-JP
type  文字列（String） ja-Hira-JP

氏名の種別

locale と一致させる必要があります

familyName  文字列（String） あいあいじぇい氏名（姓）
givenName  文字列（String） たろう氏名（名）
display ○文字列（String）  氏名
primary  真偽値（Boolean） falseこの氏名がプライマリの場合指定
拡張属性（urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User）

IIJ IDサービスが定義する外部IDプロバイダ情報を表現するための拡張属性です。

属性 必須読み取り専用型デフォルト設定例説明
externalUserName    文字列（String） iij-taro@example.jp外部IDプロバイダでのユーザ名
idTokenClaims

      IDトークンクレーム
issuer  文字列（String） iij-taro@example.jp外部IDプロバイダのissuer
subject  文字列（String） abc01234-12ab-12ab-0123-456abc外部IDプロバイダでのユニークなID（外部IDプロバイダが発行するIDトークンのsubに対応）