RPA企業アカウントの作成

この記事の内容
  1. 事前操作
  2. リクエスト
  3. リクエストヘッダー
  4. リクエストパラメータ
  5. レスポンス
  6. レスポンスデータ構造
  7. 補足説明
  8. 例
  9. 高度アカウントの作成-管理者
  10. 基本アカウントの作成-管理者
  11. 高度アカウントの作成-従業員
  12. 基本アカウントの作成-従業員

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

このインターフェースは、RPA企業アカウントを作成するために使用します。

事前操作

  1. 認証インターフェースを使用してaccessTokenを取得します。

リクエスト

基本 パラメータ値 説明
HTTP URL https://api.example.com/oapi/rpa/user/v1/create
HTTP Method POST

リクエストヘッダー

基本 パラメータ値 説明
Authorization Bearer {accessToken} {accessToken}変数は、認証インターフェースが返すaccess Tokenに置き換える必要があります

リクエストパラメータ

名称 タイプ 説明
name string 従業員の氏名、必須
account string アカウント、必須
phone string 携帯電話番号、必須
email string メールアドレス、任意
accountType string アカウントタイプ:basic 基本アカウント、senior 高度アカウント、必須
userRole string ユーザーロール:e_admin 管理者、e_user 従業員、必須
password string パスワード、必須

レスポンス

レスポンスデータ構造

名称 タイプ 説明
data object 結果データ
|─userUuid string
|─name string
|─account string
code integer 戻り値の結果コード
success boolean trueは成功、falseは失敗を示します
requestId string
msg string 結果情報

補足説明

  • codeの説明
code 説明
200 成功
400 パラメータ不足(パラメータエラー)
481 アカウントの利用可能枠が不足しています
20010009 RPA企業アカウントはすでに存在します
20010022 サポートされていないアカウントタイプ
20010033 サポートされていないロール

例

高度アカウントの作成-管理者

curl --location --request POST 'https://api.example.com/oapi/rpa/user/v1/create' \
--header 'Authorization: Bearer f62edeac-c4f3-4b34-afcf-8fc9b5ecf33c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "test0514-01",
    "account": "test0514-01",
    "phone": "13866668888",
    "email": "test@example.com",
    "accountType": "senior",
    "userRole": "e_admin",
    "password": "123456"
}'

戻り値

{
    "data": {
        "userUuid": "686397873057394688",
        "name": "test0514-01",
        "account": "test0514-01",
        "loginAccount": "test0514-01@fckj"
    },
    "code": 200,
    "success": true,
    "requestId": "1105f409-4c96-47ff-ae13-e2ff6877ddac"
}

基本アカウントの作成-管理者

curl --location --request POST 'https://api.example.com/oapi/rpa/user/v1/create' \
--header 'Authorization: Bearer f62edeac-c4f3-4b34-afcf-8fc9b5ecf33c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "test0514-02",
    "account": "test0514-02",
    "phone": "13855558888",
    "email": "test01@example.com",
    "accountType": "basic",
    "userRole": "e_admin",
    "password": "123456"
}'

戻り値

{
    "data": {
        "userUuid": "686398096118870016",
        "name": "test0514-02",
        "account": "test0514-02",
        "loginAccount": "test0514-02@fckj"
    },
    "code": 200,
    "success": true,
    "requestId": "1100b85c-2a43-427d-9ab7-62f5a255b460"
}

高度アカウントの作成-従業員

curl --location --request POST 'https://api.example.com/oapi/rpa/user/v1/create' \
--header 'Authorization: Bearer f62edeac-c4f3-4b34-afcf-8fc9b5ecf33c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "test0514-03",
    "account": "test0514-03",
    "phone": "13866668888",
    "email": "test@example.com",
    "accountType": "senior",
    "userRole": "e_user",
    "password": "123456"
}'

戻り値

{
    "data": {
        "userUuid": "686399932506796032",
        "name": "test0514-03",
        "account": "test0514-03",
        "loginAccount": "test0514-03@fckj"
    },
    "code": 200,
    "success": true,
    "requestId": "afb3b650-cfe6-4c4b-b3f2-91c3c49189e8"
}

基本アカウントの作成-従業員

curl --location --request POST 'https://api.example.com/oapi/rpa/user/v1/create' \
--header 'Authorization: Bearer f62edeac-c4f3-4b34-afcf-8fc9b5ecf33c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "test0514-04",
    "account": "test0514-04",
    "phone": "13855558888",
    "email": "test01@example.com",
    "accountType": "basic",
    "userRole": "e_user",
    "password": "123456"
}'

戻り値

{
    "data": {
        "userUuid": "686400339870183424",
        "name": "test0514-04",
        "account": "test0514-04",
        "loginAccount": "test0514-04@fckj"
    },
    "code": 200,
    "success": true,
    "requestId": "f8ac81d7-9940-4d2f-839c-d13a0fd8c537"
}
OpenAPIの記事一覧ページの先頭へ ↑