POST: ユーザーの作成

POST操作を使用して、内部のネイティブALM OctaneユーザーとLDAPユーザーの両方を作成できます。

ユーザーを追加できるコンテキスト

ユーザーを作成するには、次のいずれかのコンテキストでPOSTを実行します。 

コンテキスト 注
共有スペース

スペース管理者権限が必要です。

ロールを割り当てずに共有スペースユーザーを作成できます。この場合、ユーザーは事前定義されたviewerロールで作成されます。後でREST APIを使用してロールを割り当てる例については、PUT: ユーザーロールを更新するを参照してください。

ユーザーのPOST時にワークスペースを指定しない場合は、default_workspaceが使用されます。
ワークスペース

ワークスペース管理者の権限が必要です。

注: ほとんどのロールはカスタマイズできます。ロールとその権限は、組織によって異なる場合があります。

ワークスペースユーザーを作成するときに、ロールを割り当てる必要があります。

REST APIを使用してサイトコンテキストにユーザーを追加することはできません。

トップに戻る

内部のネイティブALM Octaneユーザーの作成

ユーザーを作成するとき、メールアドレスは一意である必要があります。同じメールアドレスを持つ別のユーザーが存在する場合、エラーが返されます。

一括POSTがサポートされています。

トップに戻る

LDAPユーザーの作成

他のユーザーと同様に、POST操作を使用して新しいLDAPユーザーを作成します。

ただし、既存のLDAPユーザーの詳細を更新するには、ALM Octane構成ヘルプの説明に従ってユーザーを再インポートします。

REST APIを使用してLDAPユーザーを作成する場合、ほとんどのLDAPプロパティには、LDAPおよびALM Octane設定で指定された値を指定する必要があります。LDAPとALM Octaneの間の属性のマッピングの詳細については、以下を参照してください。

プロパティ 説明
uid

グローバルに一意な不変の識別子として使用するLDAP属性。必須。

このドキュメントでは、これをUUID (ユニバーサル一意識別子) とも呼びます。

ALM Octaneを使用する場合は、OpenLDAPのentryUUIDを使用するのが一般的です。ただし、LDAPによっては、この属性が異なる場合があります。たとえば、objectGUID、GUID、またはorclguidなどです。

これは、ALM OctaneとLDAPとの間で同期を行うために、ALM Octane内部で各ユーザーを識別するための属性です (ALM Octaneにユーザーをインポートする場合など)。

指定しない場合、エラーが返されます。
ldap_dn

LDAPdn(識別名) は、多くの場合、LDAPentryDN属性に設定されます。必須。指定しない場合、エラーが返されます。

これは、属性と値のいくつかのペアで構成されています。dnは一意の文字列です。この文字列には、通常、cn、ou、dcなどの他のLDAP属性が含まれます。
ldap_server_id LDAPサーバーのID。オプション。
name

実際の電子メールを使用する場合、このプロパティはオプションです。この場合、ALM Octaneは、nameプロパティの標準設定値としてメールを使用します。
password パスワードはLDAPシステムによって管理されるため、POSTコマンドで指定しないでください。

例については、例: LDAPユーザーをワークスペースに追加するを参照してください。

トップに戻る

例

  • 共有スペースに1人のユーザーを追加します

  • 内部のネイティブALM Octaneユーザー管理

この例ではワークスペースが指定されていないため、ユーザーはdefault_workspaceに追加されます。

*** Request ***
POST .../api/shared_spaces/<space_id>/users
{
  "data": [
    {
      "email": "marta.santora@TheCompany.com",
      "first_name": "marta",
      "last_name": "santora",
      "name": "Marta Santora",
      "password": "Welcome1",
      "phone1": "969-979-9123"
    }
  ]
}
*** Response ***
{
  "total_count": 1,
  "data": [
    {
      "type": "sharedspace_user",
      "id": "1015"
    }
  ],
  "exceeds_total_count": false
}

トップに戻る

この例では、2人のユーザーを作成しようとしています。ただし、他のユーザーは既存のユーザーと同じ電子メールアドレスを持っているため、1つだけが作成されます。「このIDのサイトユーザーは既に存在します」という応答コード409が返されます。

*** Request ***
POST .../api/shared_spaces/<space_id>/users
{
  "data": [
    {
      "email": "marta.santora@TheCompany.com",
      "first_name": "marta",
      "last_name": "santora",
      "name": "Marta Santora",
      "password": "Welcome1",
      "phone1": "969-979-9123"
    },
 
    {
      "email": "leroy.brown@TheCompany.com",
      "first_name": "leroy",
      "last_name": "brown",
      "name": "Leroy Brown",
      "password": "Welcome1",
      "phone1": "123-356-0123"
    }

  ]
}
*** Response ***
{
  "total_count": 1,
  "data": [
    {
      "type": "sharedspace_user",
      "id": "1018"
    }
  ],
  "exceeds_total_count": false,
  "errors": [
    {
      "index": 0,
      "error_code": "platform.duplicate_entity_error",
      "correlation_id": "md7goq75nzeyquvx77x1g8yzj",
      "description": "A site_user with this email already exists.",
      "description_translated": "A site_user with this email already exists.",
      "properties": {
        "entity_type": "site_user",
        "message": "service=[CreateServiceImpl], blFlowCommand=[SharedspaceUserCreateCommand], token=[SharedspaceUserEntityToken] has thrown an exception and terminated BL flow. See service result log message for details. Error=[A site_user with this email already exists.]",
      "field_name": "email"
      },
    }
  ]
}

トップに戻る

  • ワークスペースに1人のユーザーを追加する
  • 内部のネイティブALM Octaneユーザー管理

ワークスペースにユーザーを追加するときは、必ずロールを指定してください。

この例では、1003はリーダーのロールを指します。 PUT: ユーザーロールを更新するの例は、既存のロールのリストを取得する方法を示しています。

*** Request ***
POST .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/workspace_users
{
  "data": [
    {
      "email": "marta.santora@TheCompany.com",
      "first_name": "marta",
      "last_name": "santora",
      "name": "Marta Santora",
      "password": "Welcome1",
      "phone1": "969-979-9123", 
      "roles": {
        "data": [
          {
            "type": "user_role",
            "id": "1003"
          }
        ]
      }
    }
  ]
}
*** Response ***
{
  "total_count": 1,
  "data": [
    {
      "type": "workspace_user",
      "id": "1021"
    }
  ],
  "exceeds_total_count": false
}

  • ワークスペースに1人のユーザーを追加する

  • LDAPユーザー管理

*** Request ***
POST .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/workspace_users
{
  "data": [
    {
      "uid": "b5d4a886-2347-435a-8557-e3d8561b5f38",
      "email": "sally.smith@TheCompany.com",
      "first_name": "sally",
      "last_name": "smith",
      "ldap_dn": "cn=Sally.Smith@TheCompany,ou=MyConglomerate,dc=com",
      "ldap_server_id": 1001,
      "name": "sally@TheCompany.com",
      "phone1": "969-979-9123",
      "roles": {
        "data": [
          {
            "type": "user_role",
            "id": "1003"
          }
        ]
      }
    }
  ]
}
*** Response ***
{
  "total_count": 1,
  "data": [
    {
      "type": "workspace_user",
      "id": "1021"
    }
  ],
  "exceeds_total_count": false
}

トップに戻る

参照情報: