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/modify
HTTP Method POST

リクエストヘッダー

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

リクエストパラメータ

名称 タイプ 説明
account string アカウント(変更対象のアカウントを指定します)、送信必須
name string 従業員の氏名。空の値(または空文字列、または未送信)の場合は変更しません
phone string 携帯電話番号。空の値(または空文字列、または未送信)の場合は変更しません
email string メールアドレス。空の値(または未送信、または空文字列)の場合は変更しません
userRole string ユーザーロール:e_admin 管理者、e_user 従業員。空の値(または空文字列、または未送信)の場合は変更しません

レスポンス

レスポンスデータ構造

名称 タイプ 説明
data object 結果データ
|─userUuid 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/modify' \
--header 'Authorization: Bearer 0de55cf0-b0bb-4263-bcc2-951720966624' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account": "test-0514@fckj",
    "name": "test-0514-01"
}'

戻り値

{
    "data": {
        "userUuid": "686391060106801152"
    },
    "code": 200,
    "success": true,
    "requestId": "be36f100-ea22-4d97-8f09-159ef617e03c"
}

携帯電話番号の変更

curl --location --request POST 'https://api.example.com/oapi/rpa/user/v1/modify' \
--header 'Authorization: Bearer 0de55cf0-b0bb-4263-bcc2-951720966624' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account": "test-0514@fckj",
    "phone": "13988886666"
}'

戻り値

{
    "data": {
        "userUuid": "686391060106801152"
    },
    "code": 200,
    "success": true,
    "requestId": "116e33db-01a8-427e-b021-e9da1901f127"
}

メールアドレスの変更

curl --location --request POST 'https://api.example.com/oapi/rpa/user/v1/modify' \
--header 'Authorization: Bearer 75b71079-1b81-439b-94b3-294b13b7c478' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account": "test-0514@fckj",
    "email": "test01@example.com"
}'

戻り値

{
    "data": {
        "userUuid": "686391060106801152"
    },
    "code": 200,
    "success": true,
    "requestId": "c9fc2026-4f71-4a2a-9c7d-f6041d73a3d2"
}

ユーザーロールの変更

curl --location --request POST 'https://api.example.com/oapi/rpa/user/v1/modify' \
--header 'Authorization: Bearer 75b71079-1b81-439b-94b3-294b13b7c478' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account": "test-0514@fckj",
    "userRole": "e_user"
}'

戻り値

{
    "data": {
        "userUuid": "686391060106801152"
    },
    "code": 200,
    "success": true,
    "requestId": "f9a85b50-b4a4-4393-8858-bf1a58864ac8"
}
OpenAPIの記事一覧ページの先頭へ ↑