ユーザー プロファイルの属性User profile attributes

Azure Active Directory (Azure AD) B2C ディレクトリのユーザー プロファイルには、一連の組み込み属性 (名、姓、市区町村、郵便番号、電話番号など) があります。Your Azure Active Directory (Azure AD) B2C directory user profile comes with a built-in set of attributes, such as given name, surname, city, postal code, and phone number. 外部のデータ ストアを必要とせずに、ユーザー プロファイルを独自のアプリケーション データで拡張できます。You can extend the user profile with your own application data without requiring an external data store. Azure AD B2C ユーザー プロファイルで使用できるほとんどの属性は、Microsoft Graph でもサポートされています。Most of the attributes that can be used with Azure AD B2C user profiles are also supported by Microsoft Graph. この記事では、サポートされている Azure AD B2C ユーザー プロファイルの属性について説明します。This article describes supported Azure AD B2C user profile attributes. また、これらの属性のうち Microsoft Graph でサポートされていないものや、Azure AD B2C で使用すべきではない Microsoft Graph の属性についても説明します。It also notes those attributes that are not supported by Microsoft Graph, as well as Microsoft Graph attributes that should not be used with Azure AD B2C.

重要

機密性の高い個人データ (アカウントの資格情報、政府の識別番号、カード所有者のデータ、金融口座データ、医療情報、機密性の高い経歴情報など) を保存するために組み込み属性または拡張属性を使用しないでください。You should not use built-in or extension attributes to store sensitive personal data, such as account credentials, government identification numbers, cardholder data, financial account data, healthcare information, or sensitive background information.

外部システムとの統合も可能です。You can also integrate with external systems. たとえば、認証には Azure AD B2C を使用できますが、顧客データの信頼できるソースとしての機能は、外部の顧客関係管理 (CRM) や顧客ロイヤルティ データベースに委任します。For example, you can use Azure AD B2C for authentication, but delegate to an external customer relationship management (CRM) or customer loyalty database as the authoritative source of customer data. 詳細については、リモート プロファイル ソリューションに関する記事を参照してください。For more information, see the remote profile solution.

次の表に、Azure AD B2C ディレクトリのユーザー プロファイルでサポートされているユーザー リソースの種類の属性の一覧を示します。The table below lists the user resource type attributes that are supported by the Azure AD B2C directory user profile. 各属性について次の情報を提供します。It gives the following information about each attribute:

  • Azure AD B2C で使用される属性名 (その後のかっこ内は Microsoft Graph での属性名 (異なる場合))Attribute name used by Azure AD B2C (followed by the Microsoft Graph name in parentheses, if different)
  • 属性のデータ型Attribute data type
  • 属性の説明Attribute description
  • 属性を Azure portal で使用できるかどうかIf the attribute is available in the Azure portal
  • 属性をユーザー フローで使用できるかどうかIf the attribute can be used in a user flow
  • 属性をカスタム ポリシーの Azure AD 技術プロファイルで使用できるかどうか、およびどのセクション (<InputClaims>、<OutputClaims>、または <PersistedClaims>) で使用できるかIf the attribute can be used in a custom policy Azure AD technical profile and in which section (<InputClaims>, <OutputClaims>, or <PersistedClaims>)
名前Name TypeType 説明Description Azure portalAzure portal ユーザー フローUser flows カスタム ポリシーCustom policy
accountEnabledaccountEnabled BooleanBoolean ユーザー アカウントが有効か無効か: アカウントが有効の場合は true、それ以外の場合は falseWhether the user account is enabled or disabled: true if the account is enabled, otherwise false. はいYes いいえNo Persisted、OutputPersisted, Output
ageGroupageGroup StringString ユーザーの年齢グループ。The user's age group. 指定できる値: null、Undefined、Minor、Adult、NotAdult。Possible values: null, Undefined, Minor, Adult, NotAdult. はいYes いいえNo Persisted、OutputPersisted, Output
alternativeSecurityId (Identities)alternativeSecurityId (Identities) StringString 外部 ID プロバイダーからの単一ユーザー ID。A single user identity from the external identity provider. いいえNo いいえNo Input、Persisted、OutputInput, Persisted, Output
alternativeSecurityIds (Identities)alternativeSecurityIds (Identities) 代替のセキュリティ ID コレクションalternative securityId collection 外部 ID プロバイダーからのユーザー ID のコレクション。A collection of user identities from external identity providers. いいえNo いいえNo Persisted、OutputPersisted, Output
citycity StringString ユーザーのいる市区町村。The city in which the user is located. 最大長 128。Max length 128. はいYes はいYes Persisted、OutputPersisted, Output
consentProvidedForMinorconsentProvidedForMinor StringString 未成年について同意が提供されているかどうか。Whether the consent has been provided for a minor. 使用できる値: null、granted、denied、または notRequired。Allowed values: null, granted, denied, or notRequired. はいYes いいえNo Persisted、OutputPersisted, Output
countrycountry StringString ユーザーがいる国/地域。The country/region in which the user is located. 例:"US" または "UK"。Example: "US" or "UK". 最大長 128。Max length 128. はいYes はいYes Persisted、OutputPersisted, Output
createdDateTimecreatedDateTime DateTimeDateTime ユーザー オブジェクトが作成された日付。The date the user object was created. 読み取り専用。Read only. いいえNo いいえNo Persisted、OutputPersisted, Output
creationTypecreationType StringString ユーザー アカウントが Azure Active Directory B2C テナントのローカル アカウントとして作成された場合、値は LocalAccount または nameCoexistence です。If the user account was created as a local account for an Azure Active Directory B2C tenant, the value is LocalAccount or nameCoexistence. 読み取り専用。Read only. いいえNo いいえNo Persisted、OutputPersisted, Output
dateOfBirthdateOfBirth DateDate 誕生日。Date of birth. いいえNo いいえNo Persisted、OutputPersisted, Output
departmentdepartment StringString ユーザーが勤務する部署の名前。The name for the department in which the user works. 最大長 64。Max length 64. はいYes いいえNo Persisted、OutputPersisted, Output
displayNamedisplayName StringString ユーザーの表示名。The display name for the user. 最大長 256。Max length 256. はいYes はいYes Persisted、OutputPersisted, Output
facsimileTelephoneNumber1facsimileTelephoneNumber1 StringString ユーザーの業務用ファックスの電話番号。The telephone number of the user's business fax machine. はいYes いいえNo Persisted、OutputPersisted, Output
givenNamegivenName StringString ユーザーの名。The given name (first name) of the user. 最大長 64。Max length 64. はいYes はいYes Persisted、OutputPersisted, Output
jobTitlejobTitle StringString ユーザーの役職。The user's job title. 最大長 128。Max length 128. はいYes はいYes Persisted、OutputPersisted, Output
immutableIdimmutableId StringString オンプレミスの Active Directory から移行されたユーザーに通常使用される識別子。An identifier which is typically used for users migrated from on-premises Active Directory. いいえNo いいえNo Persisted、OutputPersisted, Output
legalAgeGroupClassificationlegalAgeGroupClassification StringString 法的年齢グループの分類。Legal age group classification. 読み取り専用で、ageGroup および consentProvidedForMinor プロパティに基づいて計算されます。Read-only and calculated based on ageGroup and consentProvidedForMinor properties. 使用可能な値: null、minorWithOutParentalConsent、minorWithParentalConsent、minorNoParentalConsentRequired、notAdult、および adult。Allowed values: null, minorWithOutParentalConsent, minorWithParentalConsent, minorNoParentalConsentRequired, notAdult and adult. はいYes いいえNo Persisted、OutputPersisted, Output
legalCountry1legalCountry1 StringString 国またはリージョン (法的な目的)。Country/Region for legal purposes. いいえNo いいえNo Persisted、OutputPersisted, Output
mailmail StringString ユーザーの SMTP アドレス (例 "bob@contoso.com")。The SMTP address for the user, for example, "bob@contoso.com". 読み取り専用です。Read-only. いいえNo いいえNo Persisted、OutputPersisted, Output
mailNickNamemailNickName StringString ユーザーのメール エイリアス。The mail alias for the user. 最大長 64。Max length 64. いいえNo いいえNo Persisted、OutputPersisted, Output
mobile (mobilePhone)mobile (mobilePhone) StringString ユーザーのメインの携帯電話番号。The primary cellular telephone number for the user. 最大長 64。Max length 64. はいYes いいえNo Persisted、OutputPersisted, Output
netIdnetId StringString Net ID。Net ID. いいえNo いいえNo Persisted、OutputPersisted, Output
objectIdobjectId StringString ユーザーの一意識別子であるグローバル一意識別子 (GUID)。A globally unique identifier (GUID) that is the unique identifier for the user. 例:12345678-9abc-def0-1234-56789abcde。Example: 12345678-9abc-def0-1234-56789abcde. 読み取り専用で、変更できません。Read only, Immutable. 読み取り専用Read only はいYes Input、Persisted、OutputInput, Persisted, Output
otherMailsotherMails 文字列コレクションString collection ユーザーのその他の電子メール アドレスの一覧。A list of additional email addresses for the user. 例: ["bob@contoso.com", "Robert@fabrikam.com"]。Example: ["bob@contoso.com", "Robert@fabrikam.com"]. はい (連絡用電子メール アドレス)Yes (Alternate email) いいえNo Persisted、OutputPersisted, Output
passwordpassword StringString ユーザー作成時のローカル アカウントのパスワード。The password for the local account during user creation. いいえNo いいえNo PersistedPersisted
passwordPoliciespasswordPolicies StringString パスワードのポリシー。Policy of the password. コンマで区切られた複数のポリシー名で構成される文字列です。It's a string consisting of different policy name separated by comma. 例: "DisablePasswordExpiration, DisableStrongPassword"。i.e. "DisablePasswordExpiration, DisableStrongPassword". いいえNo いいえNo Persisted、OutputPersisted, Output
physicalDeliveryOfficeName (officeLocation)physicalDeliveryOfficeName (officeLocation) StringString ユーザーの勤務先のオフィス所在地。The office location in the user's place of business. 最大長 128。Max length 128. はいYes いいえNo Persisted、OutputPersisted, Output
postalCodepostalCode StringString ユーザーの住所の郵便番号。The postal code for the user's postal address. 郵便番号は、ユーザーの国/地域に固有です。The postal code is specific to the user's country/region. 米国では、この属性に ZIP コードが含まれます。In the United States of America, this attribute contains the ZIP code. 最大長 40。Max length 40. はいYes いいえNo Persisted、OutputPersisted, Output
preferredLanguagepreferredLanguage StringString ユーザーの優先言語。The preferred language for the user. ISO 639-1 コードに従う必要があります。Should follow ISO 639-1 Code. 例: "en-US"。Example: "en-US". いいえNo いいえNo Persisted、OutputPersisted, Output
refreshTokensValidFromDateTimerefreshTokensValidFromDateTime DateTimeDateTime この日時より前に発行された更新トークンは無効です。無効な更新トークンを使用して新しいアクセス トークンを取得すると、アプリケーションでエラーが発生します。Any refresh tokens issued before this time are invalid, and applications will get an error when using an invalid refresh token to acquire a new access token. この場合、アプリケーションは、承認エンドポイントに対して要求を行うことによって、新しい更新トークンを取得する必要があります。If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. 読み取り専用です。Read-only. いいえNo いいえNo 出力Output
signInNames (Identities)signInNames (Identities) StringString ディレクトリ内の任意の種類のローカル アカウント ユーザーの一意のサインイン名。The unique sign-in name of the local account user of any type in the directory. ローカル アカウントの種類を指定せずにサインイン値でユーザーを取得するには、これを使用します。Use this to get a user with sign-in value without specifying the local account type. いいえNo いいえNo 入力Input
signInNames.userName (Identities)signInNames.userName (Identities) StringString ディレクトリ内のローカル アカウント ユーザーの一意のユーザー名。The unique username of the local account user in the directory. 特定のサインイン ユーザー名でユーザーを作成または取得するには、これを使用します。Use this to create or get a user with a specific sign-in username. パッチ操作中に PersistedClaims 単独でこれを指定すると、他の種類の signInNames は削除されます。Specifying this in PersistedClaims alone during Patch operation will remove other types of signInNames. 新しい種類の signInNames を追加する場合は、既存の signInNames も保持する必要があります。If you would like to add a new type of signInNames, you also need to persist existing signInNames. いいえNo いいえNo Input、Persisted、OutputInput, Persisted, Output
signInNames.phoneNumber (Identities)signInNames.phoneNumber (Identities) StringString ディレクトリ内のローカル アカウント ユーザーの一意の電話番号。The unique phone number of the local account user in the directory. 特定のサインイン電話番号でユーザーを作成または取得するには、これを使用します。Use this to create or get a user with a specific sign-in phone number. パッチ操作中に PersistedClaims 単独でこれを指定すると、他の種類の signInNames は削除されます。Specifying this in PersistedClaims alone during Patch operation will remove other types of signInNames. 新しい種類の signInNames を追加する場合は、既存の signInNames も保持する必要があります。If you would like to add a new type of signInNames, you also need to persist existing signInNames. いいえNo いいえNo Input、Persisted、OutputInput, Persisted, Output
signInNames.emailAddress (Identities)signInNames.emailAddress (Identities) StringString ディレクトリ内のローカル アカウント ユーザーの一意のメール アドレス。The unique email address of the local account user in the directory. 特定のサインイン電子メール アドレスでユーザーを作成または取得するには、これを使用します。Use this to create or get a user with a specific sign-in email address. パッチ操作中に PersistedClaims 単独でこれを指定すると、他の種類の signInNames は削除されます。Specifying this in PersistedClaims alone during Patch operation will remove other types of signInNames. 新しい種類の signInNames を追加する場合は、既存の signInNames も保持する必要があります。If you would like to add a new type of signInNames, you also need to persist existing signInNames. いいえNo いいえNo Input、Persisted、OutputInput, Persisted, Output
statestate StringString ユーザーの住所の都道府県。The state or province in the user's address. 最大長 128。Max length 128. はいYes はいYes Persisted、OutputPersisted, Output
streetAddressstreetAddress StringString ユーザーの勤務地の番地。The street address of the user's place of business. 最大長 1024。Max length 1024. はいYes はいYes Persisted、OutputPersisted, Output
strongAuthentication AlternativePhoneNumber1strongAuthentication AlternativePhoneNumber1 StringString 多要素認証に使用される、ユーザーの 2 次電話番号。The secondary telephone number of the user, used for multi-factor authentication. はいYes いいえNo Persisted、OutputPersisted, Output
strongAuthenticationEmailAddress1strongAuthenticationEmailAddress1 StringString ユーザーの SMTP アドレス。The SMTP address for the user. 例: "bob@contoso.com"。この属性は、ユーザー名ポリシーでのサインインで、ユーザーの電子メール アドレスを保存するために使用されます。Example: "bob@contoso.com" This attribute is used for sign-in with username policy, to store the user email address. この電子メール アドレスは、パスワード リセット フローで使用されます。The email address then used in a password reset flow. はいYes いいえNo Persisted、OutputPersisted, Output
strongAuthenticationPhoneNumber1strongAuthenticationPhoneNumber1 StringString 多要素認証に使用される、ユーザーの 1 次電話番号。The primary telephone number of the user, used for multi-factor authentication. はいYes いいえNo Persisted、OutputPersisted, Output
surnamesurname StringString ユーザーの姓。The user's surname (family name or last name). 最大長 64。Max length 64. はいYes はいYes Persisted、OutputPersisted, Output
telephoneNumber (businessPhones の最初のエントリ)telephoneNumber (first entry of businessPhones) StringString ユーザーの勤務地の 1 次電話番号。The primary telephone number of the user's place of business. はいYes いいえNo Persisted、OutputPersisted, Output
userPrincipalNameuserPrincipalName StringString ユーザーのユーザー プリンシパル名 (UPN)。The user principal name (UPN) of the user. UPN は、インターネット標準 RFC 822 に基づくユーザーのインターネット形式のログイン名です。The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. ドメインがテナントの確認済みドメインのコレクションに存在している必要があります。The domain must be present in the tenant's collection of verified domains. このプロパティは、アカウントを作成するときに必要です。This property is required when an account is created. 変更不可。Immutable. いいえNo いいえNo Input、Persisted、OutputInput, Persisted, Output
usageLocationusageLocation StringString 法的な要請のためにライセンスを割り当てられるユーザーが、各国またはリージョンでサービスを利用できるかどうかを確認するのに必要です。Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries/regions. NULL 値は許可されません。Not nullable. 2 文字の国またはリージョン番号 (ISO 標準 3166)。A two letter country/region code (ISO standard 3166). 例 :"US"、"JP"、"GB"。Examples: "US", "JP", and "GB". はいYes いいえNo Persisted、OutputPersisted, Output
userTypeuserType StringString ディレクトリ内のユーザー タイプを分類するために使用できる文字列値。A string value that can be used to classify user types in your directory. 値は Member にする必要があります。Value must be Member. 読み取り専用です。Read-only. 読み取り専用Read only いいえNo Persisted、OutputPersisted, Output
userState (externalUserState)2userState (externalUserState)2 StringString Azure AD B2B アカウント専用。招待が PendingAcceptance であるか Accepted であるかを示します。For Azure AD B2B account only, indicates whether the invitation is PendingAcceptance or Accepted. いいえNo いいえNo Persisted、OutputPersisted, Output
userStateChangedOn (externalUserStateChangeDateTime)2userStateChangedOn (externalUserStateChangeDateTime)2 DateTimeDateTime UserState プロパティに対する最新の変更のタイムスタンプを示します。Shows the timestamp for the latest change to the UserState property. いいえNo いいえNo Persisted、OutputPersisted, Output
1 Microsoft Graph ではサポート対象外1 Not supported by Microsoft Graph
2 Azure AD B2C では使用不可2 Should not be used with Azure AD B2C

拡張属性Extension attributes

次のような場合、通常は独自の属性を作成する必要があります。You'll often need to create your own attributes, as in the following cases:

  • 顧客向けアプリケーションを、LoyaltyNumber のような属性に対して維持する必要がある。A customer-facing application needs to persist for an attribute like LoyaltyNumber.
  • ID プロバイダーは、uniqueUserGUID のような、保存する必要がある一意のユーザー識別子を保持しています。An identity provider has a unique user identifier like uniqueUserGUID that must be saved.
  • カスタム ユーザー体験を、migrationStatus のようなユーザーの状態に対して維持する必要がある。A custom user journey needs to persist for a state of a user, like migrationStatus.

Azure AD B2C では、各ユーザー アカウントで保存される属性セットを拡張できます。Azure AD B2C extends the set of attributes stored on each user account. 拡張属性は、ディレクトリ内のユーザー オブジェクトのスキーマを拡張します。Extension attributes extend the schema of the user objects in the directory. 拡張属性は、ユーザーに関するデータを保持できる場合でも、アプリケーション オブジェクトにしか登録できません。The extension attributes can only be registered on an application object, even though they might contain data for a user. 拡張属性は、b2c-extensions-app というアプリケーションに関連付けられます。The extension attribute is attached to the application called b2c-extensions-app. Azure AD B2C は、ユーザー データを保存するためにこのアプリケーションを使用します。このため、このアプリケーションは変更しないでください。Do not modify this application, as it's used by Azure AD B2C for storing user data. このアプリケーションは Azure Active Directory アプリの登録で確認できます。You can find this application under Azure Active Directory App registrations.

注意

  • 最大 100 の拡張属性を任意のユーザー アカウントに書き込むことができます。Up to 100 extension attributes can be written to any user account.
  • b2c-extensions-app アプリケーションが削除されると、これらの拡張属性は、格納されているデータと共に、すべてのユーザーから削除されます。If the b2c-extensions-app application is deleted, those extension attributes are removed from all users along with any data they contain.
  • 拡張属性は、アプリケーションによって削除されると、すべてのユーザー アカウントから削除され、その値も削除されます。If an extension attribute is deleted by the application, it's removed from all user accounts and the values are deleted.
  • 拡張属性の基になる名前は、"Extension_" + アプリケーション ID + "" + 属性名の形式で生成されます。The underlying name of the extension attribute is generated in the format "Extension" + Application ID + "_" + Attribute name. たとえば、拡張属性 LoyaltyNumber を作成し、b2c-extensions-app アプリケーション ID が 831374b3-bd50-41bf-aa54-263ec9e050fc の場合、基になる拡張属性名は extension_831374b3bd5041bfaa54263ec9e050fc_LoyaltyNumber となります。For example, if you create an extension attribute LoyaltyNumber, and the b2c-extensions-app Application ID is 831374b3-bd50-41bf-aa54-263ec9e050fc, the underlying extension attribute name will be: extension_831374b3bd5041bfaa54263ec9e050fc_LoyaltyNumber. ユーザー アカウントを作成または更新するために Graph API クエリを実行する場合は、この基になる名前を使用します。You use the underlying name when you run Graph API queries to create or update user accounts.

スキーマ拡張でプロパティを定義する場合、次のデータ型がサポートされます。The following data types are supported when defining a property in a schema extension:

プロパティの種類Property type 解説Remarks
BooleanBoolean 使用可能な値: True または FalsePossible values: true or false.
DateTimeDateTime ISO 8601 形式で指定する必要があります。Must be specified in ISO 8601 format. UTC で保存されます。Will be stored in UTC.
IntegerInteger 32 ビット値。32-bit value.
StringString 最大 256 文字。256 characters maximum.

次のステップNext steps

拡張属性に関する詳細情報:Learn more about extension attributes: