ユーザーを作成するCreate User

名前空間: microsoft.graphNamespace: microsoft.graph

新しいユーザーを作成します。要求本文に、作成するユーザーを含めます。少なくとも、ユーザーについての必須プロパティを指定する必要があります。必要に応じて、その他の書き込み可能なプロパティを指定することもできます。Create a new user. The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties.

注意

外部ユーザーを作成するには、招待 API を使用します。To create external users, use the invitation API.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) User.ReadWrite.All、Directory.ReadWrite.All、Directory.AccessAsUser.AllUser.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication User.ReadWrite.All、Directory.ReadWrite.AllUser.ReadWrite.All, Directory.ReadWrite.All

HTTP 要求HTTP request

POST /users

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

要求本文で、ユーザー オブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation of user object.

次の表に、ユーザーの作成時に必要になるプロパティを一覧表示します。The following table lists the properties that are required when you create a user. 作成しているユーザーの ID プロパティが含まれている場合は、一覧に表示されているすべてのプロパティが必須ではありません。If you're including an identities property for the user you're creating, not all the properties listed are required. B2C ローカル アカウント ID には passwordProfile のみが必要です。PasswordprofileDisablePasswordExpiration に設定する必要があります。For a B2C local account identity, only passwordProfile is required, and passwordPolicy must be set to DisablePasswordExpiration. ソーシャル ID の場合、プロパティは必要ありません。For a social identity, none of the properties are required.

パラメーターParameter 種類Type 説明Description
accountEnabledaccountEnabled booleanboolean アカウントが有効な場合は true。それ以外の場合は false。true if the account is enabled; otherwise, false.
displayNamedisplayName stringstring ユーザーのアドレス帳に表示される名前。The name to display in the address book for the user.
onPremisesImmutableIdonPremisesImmutableId stringstring ユーザーの userPrincipalName (UPN) プロパティにフェデレーション ドメインを使用している場合は、新しいユーザー アカウントの作成時にのみ指定する必要がありますOnly needs to be specified when creating a new user account if you are using a federated domain for the user's userPrincipalName (UPN) property.
mailNicknamemailNickname stringstring ユーザーのメール エイリアス。The mail alias for the user.
passwordProfilepasswordProfile PasswordProfilePasswordProfile ユーザーのパスワード プロファイル。The password profile for the user.
userPrincipalNameuserPrincipalName stringstring ユーザー プリンシパル名 (someuser@contoso.com)。The user principal name (someuser@contoso.com).

ユーザー リソースは拡張機能をサポートしているため、POST 操作を使用して、リソースの作成時にカスタム プロパティを独自のデータとともにユーザー インスタンスに追加することができます。Because the user resource supports extensions, you can use the POST operation and add custom properties with your own data to the user instance while creating it.

注意

この API を使用して作成されたフェデレーション ユーザーは、既定で 12 時間ごとに強制サインインされます。Federated users created using this API will be forced to sign-in every 12 hours by default. この設定を変更する方法の詳細については、「トークンの有効期間の例外」を参照してください。For more information on how to change this, see Exceptions for token lifetimes.

応答Response

成功した場合、このメソッドは 201 Created 応答コードと、応答本文でユーザー オブジェクトを返します。If successful, this method returns 201 Created response code and user object in the response body.

Example

例 1: ユーザーを作成するExample 1: Create a user

要求Request

以下は、要求の例です。Here is an example of the request.

POST https://graph.microsoft.com/v1.0/users
Content-type: application/json

{
  "accountEnabled": true,
  "displayName": "displayName-value",
  "mailNickname": "mailNickname-value",
  "userPrincipalName": "upn-value@tenant-value.onmicrosoft.com",
  "passwordProfile" : {
    "forceChangePasswordNextSignIn": true,
    "password": "password-value"
  }
}

要求本文で、ユーザー オブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation of user object.

応答Response

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
    "id": "id-value",
    "businessPhones": [],
    "displayName": "displayName-value",
    "givenName": null,
    "jobTitle": null,
    "mail": null,
    "mobilePhone": null,
    "officeLocation": null,
    "preferredLanguage": null,
    "surname": null,
    "userPrincipalName": "upn-value@tenant-value.onmicrosoft.com"
}

例 2: ソーシャルおよびローカルのアカウント ID でユーザーを作成するExample 2: Create a user with social and local account identities

サインイン名 (サインイン用のメール アドレス)、およびソーシャル ID を持つローカル アカウント ID を使用して、新しいユーザーを作成します。Create a new user, with a local account identity with a sign-in name, an email address as sign-in, and with a social identity. この例は、主に B2C テナントの移行シナリオで使用されます。This example is typically used for migration scenarios in B2C tenants.

注意

ローカル アカウント ID の場合、パスワードの有効期限を無効にし、次回のサインイン時にパスワードを強制的に変更することも無効にする必要があります。For local account identities, password expirations must be disabled, and force change password at next sign-in must also be disabled.

要求Request

POST https://graph.microsoft.com/v1.0/users
Content-type: application/json

{
  "displayName": "John Smith",
  "identities": [
    {
      "signInType": "userName",
      "issuer": "contoso.onmicrosoft.com",
      "issuerAssignedId": "johnsmith"
    },
    {
      "signInType": "emailAddress",
      "issuer": "contoso.onmicrosoft.com",
      "issuerAssignedId": "jsmith@yahoo.com"
    },
    {
      "signInType": "federated",
      "issuer": "facebook.com",
      "issuerAssignedId": "5eecb0cd"
    }
  ],
  "passwordProfile" : {
    "password": "password-value",
    "forceChangePasswordNextSignIn": false
  },
  "passwordPolicies": "DisablePasswordExpiration"
}

応答Response

以下は、応答の例です。Here is an example of the response.

注: 読みやすくするために、ここに示す応答オブジェクトは短縮されている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
  "displayName": "John Smith",
  "id": "4c7be08b-361f-41a8-b1ef-1712f7a3dfb2",
  "identities": [
    {
      "signInType": "userName",
      "issuer": "contoso.onmicrosoft.com",
      "issuerAssignedId": "johnsmith"
    },
    {
      "signInType": "emailAddress",
      "issuer": "contoso.onmicrosoft.com",
      "issuerAssignedId": "jsmith@yahoo.com"
    },
    {
      "signInType": "federated",
      "issuer": "facebook.com",
      "issuerAssignedId": "5eecb0cd"
    }
  ],
  "passwordPolicies": "DisablePasswordExpiration"
}

関連項目See also