ユーザー

ほとんどの場合、ユーザーとは ClaimCenter に認識され、ClaimCenter データベースに登録されている人物です（保険契約引受担当者、クレーム担当者、請求担当者など）。Cloud API 認証のコンテキスト内では、内部ユーザーとも呼ばれます。

場合によってはサービスを表すこともあります。これは、呼び出し元アプリケーションがアクセス管理のためにユーザーアカウントにマッピングされるサービスである場合です。

内部ユーザーと外部ユーザーを混同してはなりません。外部ユーザーとは、ClaimCenter に認識されているものの、ClaimCenter データベースに登録されていないユーザーです（アカウント名義人、保険契約者、サービス業者など）。

サービスの操作および外部ユーザーの詳細については、『Cloud API 認証ガイド』を参照してください。

ユーザーの作成

ユーザーを作成するには、次のエンドポイントを使用します。

  • POST /admin/v1/users
注: Cloud API を使用してユーザーを作成すると、そのユーザーのパスワードは認証に使用できない値に設定されます（パスワードは有効な Base64 文字列ではない値に設定されますが、認証フレームワークで認証できるパスワードは、有効な Base64 文字列に限られます）。新規ユーザーを認証できるようにするには、まず他の何らかの方法（ユーザーインターフェイスなど）でパスワードを有効な Base64 文字列に変更する必要があります。

最小限のユーザーの作成

最小限のユーザー作成条件は username です。例えば、次の要求はユーザー名が「amartin」のユーザーを作成します。

{
  "data": {
    "attributes": {
      "username": "amartin"
    }
  }
}

応答ペイロードは次のとおりです。

POST /admin/v1/users
 
{
    "data": {
        "attributes": {
            "active": true,
            "displayName": "",
            "externalUser": false,
            "id": "cc:SVA-tE4oV6qcNvofjff8v",
            "username": "amartin",
            "vacationStatus": {
                "code": "atwork",
                "name": "At work"
            }
        },
        "checksum": "590697d4d0c3ccc1728d9f2d1d8c4051",
        "links": {
            "self": {
                "href": "/admin/v1/users/cc:SVA-tE4oV6qcNvofjff8v",
                "methods": [
                    "get",
                    "patch"
                ]
            }
        }
    }
}

一般的なユーザーの作成

User スキーマで指定されているように、ユーザーに関する追加情報を指定できます。例えば、次のペイロードは以下の属性を持つユーザーを作成します。

  • 名： Adriana
  • 姓： Diaz
  • ユーザー名：adiaz
  • 従業員番号：ACME-02027
  • 役割：アカウントマネージャ（account_manager）および担当者（adjuster）
POST /admin/v1/users

{
  "data": {
    "attributes": {
        "firstName": "Adriana",
        "lastName": "Diaz",
        "username": "adiaz",
        "employeeNumber": "ACME-02027",
        "roles" : [
            {
                "id": "account_manager"
            },
            {
                "id": "adjuster"
            }
        ]
    }
  }
}

ユーザーを作成する際、ユーザー役割と権限制限プロファイルを指定することもできます。

  • ユーザー役割の使用に関する詳細については、ユーザー役割を参照してください。
  • 権限制限プロファイルの使用に関する詳細については、権限制限プロファイルを参照してください。

グループへのユーザーのアサイン

/admin/v1/users エンドポイントを使用してユーザーをグループにアサインすることはできません。/admin/v1/groups/{groupId}/users エンドポイントを使用する必要があります。詳細については、グループへのユーザーのアサインを参照してください。

ユーザーの更新

既存のユーザーを変更するには、次のエンドポイントを使用します。

  • PATCH /admin/v1/users/{userId}

例えば、以下の要求はユーザー xc:2156 の名を更新します。

PATCH /admin/v1/users/xc:2156

{
  "data": {
    "attributes": {
      "firstName": "Alex"
    }
  }
}