Search

ユーザー管理API

Version 24.2.9064

ユーザー管理API

ユーザー管理API は次のアクションをサポートします。

以下のセクションでは、各アクションについて説明します。

Note：ユーザーを作成または変更するときは、API ロール名を使用する必要があります。次のテーブルは、ユーザーロールを相当するAPI にマッピングしたものです。

ユーザーロール名 API ロール名
Admin cdata_admin
Standard cdata_standard
Job Creator cdata_job_creator
Job Operator cdata_support

ユーザーを作成

次のコマンドは、CData Sync アプリケーションでユーザーを作成します。

POST http://MyDomain.com:8019/api.rsc/users

ボディパラメータ

名前 説明
User ユーザーの識別子を指定します。
Active ユーザーがアクティブかどうかを指定します。
Password ユーザーのパスワードを指定します。
Roles ユーザーのロールを指定します。
FederationId SSO 認証用のフェデレーションId を指定します。

例

{ 
  "User": "APIUser",
  "Active": true,
  "Password": "APIUser",
  "Roles":  "cdata_admin"
}

複数のユーザーを作成

次のコマンドは、Sync アプリケーションで複数のユーザーを作成します。

POST http://MyDomain.com:8019/api.rsc/createUsers

ボディパラメータ

名前 説明
User ユーザーの識別子を指定します。
Active ユーザーがアクティブかどうかを指定します。
Password ユーザーのパスワードを指定します。
Roles ユーザーのロールを指定します。
FederationId SSO 認証用のフェデレーションId を指定します。

例

{ 
  "User1": "APIUser1",
  "Password#1": "APIUser1$",
  "Roles#1": "cdata_admin",
  "FederationId#1": "User1Id",
  "User#2": "APIUser2", 
  "Password#2": "APIUser2$",
  "Roles#2": "cdata_admin",
  "FederationId#1": "User2Id"
}

すべてのユーザーをリスト

次のコマンドは、CData Sync アプリケーションのすべてのユーザーのリストを返します。

GET http://MyDomain.com:8019/api.rsc/users(Name)

クエリパラメータ

名前 説明
User 取得するユーザーの名前を指定します。

ユーザーを編集

次のコマンドは、既存のユーザーを編集します。User、ExpiredIn、Active、およびRoles フィールドのみ編集可能です。

PUT http://MyDomain.com:8019/api.rsc/users(Name)

クエリパラメータ

名前 説明
User（必須） 編集するユーザーの名前を指定します。

ボディパラメータ

名前 説明
User ユーザーの名前を指定します。
Password ユーザーのパスワードを指定します。
Active ユーザーがアクティブかどうかを指定します。
ExpiredIn 認証トークンの有効期限が切れるまでの日数を指定します。
Roles ユーザーのロールを指定します。

例

{ 
  "User": "MyUser",
  "Password": "MyPassword",
  "Active": true,
  "ExpiredIn": 100,
  "Roles": "cdata_standard"
}