ユーザーAPI (/users)
概要
ユーザーAPIを使用すると、ユーザーの作成、更新、照会を行えます。 これには基本的な人口統計からパスワードの管理、グループの管理、承認権限の管理までが含まれます。
ユーザーにアクセスするためのURLは次のとおりです。 https ://{your_instance_name}/api/users
詳細については、統合のベストプラクティスを参照してください。
アクション
ユーザーAPIでは以下の操作が可能です。
|
動詞 |
パス |
アクション |
Description |
|---|---|---|---|
|
POST |
|
作成 |
ユーザーを作成する |
|
GET |
|
インデックス |
ユーザーを検索する |
|
GET |
|
表示 |
ユーザーを表示する |
|
PUT |
|
更新 |
ユーザーを更新する |
Elements
ユーザーAPIでは、次の要素を使用できます。
|
要素 |
Description |
必須フィールド? |
一意? |
許容値 |
Api_Inフィールド? |
Api_Outフィールド? |
データタイプ |
|---|---|---|---|---|---|---|---|
|
account-groups |
account_groups |
yes |
yes |
アカウントグループ |
|||
|
account-security-type |
account_security_type |
yes |
yes |
整数 |
|||
|
アクティブ |
trueの場合、ユーザーはアクティブです。 クエリパラメータ |
yes |
yes |
boolean |
|||
|
aic-user |
AI分類ライセンスの有無 |
no |
no |
yes/no; true/false |
yes |
boolean |
|
|
analytics-user |
Analyticsライセンスの有無 |
yes |
yes |
boolean |
|||
|
api-user |
APIユーザーかどうか |
yes |
boolean |
||||
|
approval-groups |
approval_groups |
yes |
yes |
承認グループ |
|||
|
approval-limit |
承認上限金額。 |
yes |
承認限度 |
||||
|
authentication-method |
使用される認証方式(Coupa_Credentials、LDAP、SAML) 注 認証方法では大文字と小文字が区別されます |
yes |
yes |
string(255) |
|||
|
avatar-thumb-url |
APIを使用したアバターの更新は、セキュリティ上の理由により現在ではサポートされていません。 |
なし |
yes |
文字列 |
|||
|
business-function |
職務 |
yes |
string(255) |
||||
|
business-group-security-type |
business_group_security_type |
0, 1 |
yes |
yes |
整数 |
||
|
can-expense-for |
can_expense_for |
yes |
ユーザー |
||||
|
category_planner_user |
Category Plannerライセンスの有無 |
yes |
yes |
boolean |
|||
| category_strategy_user | ユーザーはカテゴリ戦略ライセンスを持っていますか? | no | yes | boolean | |||
|
ccw-user |
社外リソース管理ライセンスの有無 |
no |
no |
any |
yes |
yes |
boolean |
|
content-groups |
Content Groups |
yes |
yes |
||||
|
contract-approval-limit |
契約の承認限度 |
yes |
yes |
承認限度 |
|||
|
contract-self-approval-limit |
契約の自己承認限度 |
yes |
yes |
承認限度 |
|||
|
contracts-user |
契約ライセンスの有無 |
yes |
yes |
boolean |
|||
|
country-of-residence |
居住国 |
no |
no |
any |
yes |
yes |
Country |
|
作成日時 |
CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します |
yes |
datetime |
||||
|
created-by |
作成したユーザー |
yes |
ユーザー |
||||
|
default-account |
デフォルトアカウント |
yes |
yes |
||||
|
default-account-type |
default_account_type |
yes |
yes |
||||
|
default-address |
default_address |
yes |
yes |
||||
|
default-currency |
必須フィールドではありません。 ただし、値が指定されておらず、ユーザーレコードにも既定の通貨が設定されていない場合は、インスタンスのレポート通貨が既定の通貨として使用されます。 |
yes |
yes |
||||
|
default-locale |
en, tr, ja, bg, cs, es, da, de-AT, de-BE, de-CH, de-LU, de, el, en-AU, en-CA, en-CN, en-GB, en-HK, en-IE, en-IN, en-ME, en-MT, en-MY, en-NZ, en-PH, en-SG, en_TW, en-ZA, es-CO, es-MX, es-PR, et, fi, fr-BE, fr-CA, fr-CH, fr-LU, fr, hr, hu, it-CH, it, ko, lt, lv, mt, nl-BE, nl, no, pl, pt-BR, pt, ro, ru, sk, sl, sr, sv, zh-CN, zh-HK, zh-TW, en-ZZ, en, tr, ja, bg, cs, es, da, de-AT, de-BE, de-CH, de-LU, de, el, en-AU, en-CA, en-GB, en-HK, en-IE, en-IN, en-MT, en-MY, en-NZ, en-SG, en-ZA, es-CO, es-MX, es-PR, et, fi, fr-BE, fr-CA, fr-CH, fr-LU, fr, hr, hu, it-CH, it, ko, lt, lv, mt, nl-BE, nl, no, pl, pt-BR, pt, ro, ru, sk, sl, sr, sv, zh-CN, zh-HK, zh-TW, en-ZZ, es-IC |
yes |
yes |
string(10) |
|||
|
部署 |
部署 |
yes |
yes |
||||
|
|
|
yes |
yes |
yes |
yes |
string(255) |
|
|
employee-number |
従業員番号 |
yes |
yes |
yes |
string(255) |
||
|
employee-payment-channel |
従業員への支払方法 (デフォルトは「ERP」、インスタンス設定によって「CoupaPay」も可) |
yes |
yes |
string(255) |
|||
|
escalation-threshold |
エスカレーションのしきい値 |
no |
no |
any |
yes |
yes |
承認限度 |
|
expense-approval-limit |
expense_approval_limit |
yes |
yes |
承認限度 |
|||
|
expense-self-approval-limit |
expense_self_approval_limit |
yes |
yes |
承認限度 |
|||
|
expense-user |
経費ライセンスの有無 |
yes |
yes |
boolean |
|||
|
expenses-delegated-to |
経費委託先 |
yes |
ユーザー |
||||
|
firstname |
名 |
yes |
yes |
yes |
string(40) |
||
|
fullname |
氏名 |
yes |
string(255) |
||||
|
generate-password-and-notify |
ユーザーをシステムに招待し、パスワード設定を促す場合は「はい」に設定してください |
はい/いいえ |
yes |
文字列 |
|||
|
ID |
Coupaの一意の識別子 |
yes |
整数 |
||||
|
inventory-organizations |
inventory_organizations |
yes |
yes |
在庫組織 |
|||
|
inventory-user |
在庫ライセンスの有無 |
yes |
yes |
boolean |
|||
|
invoice-approval-limit |
invoice_approval_limit |
yes |
yes |
承認限度 |
|||
|
invoice-self-approval-limit |
請求書の自己承認上限 |
yes |
承認限度 |
||||
|
invoicing_user |
請求ライセンスの有無 |
yes |
boolean |
||||
|
lastname |
姓 |
yes |
yes |
yes |
string(40) |
||
|
login |
login |
yes |
yes |
yes |
yes |
string(255) |
|
|
manager |
マネージャー |
yes |
yes |
ユーザー |
|||
|
mention-name |
メンション名 |
yes |
yes |
yes |
string(255) |
||
|
password |
変更されたパスワード |
yes |
文字列 |
||||
|
phone-mobile |
携帯電話番号 |
yes |
yes |
電話番号 |
|||
|
phone-work |
勤務先電話番号 |
yes |
yes |
電話番号 |
|||
|
purchasing-user |
購入ライセンスの有無 |
yes |
yes |
boolean |
|||
|
requisition-approval-limit |
requisition_approval_limit |
yes |
yes |
承認限度 |
|||
|
requisition-self-approval-limit |
requisition_self_approval_limit |
yes |
yes |
承認限度 |
|||
|
risk-assess-user |
Risk Assessライセンスの有無 |
yes |
yes |
boolean |
|||
|
roles |
roles |
yes |
yes |
役割 |
|||
|
salesforce-enabled |
salesforce_enabled |
yes |
boolean |
||||
|
salesforce-id |
salesforce_id |
yes |
yes |
yes |
string(255) |
||
|
self-approval-limit |
自己承認上限 |
yes |
承認限度 |
||||
|
seniority-level |
社内等級または職位。 |
yes |
yes |
string(255) |
|||
|
sourcing-user |
ソーシングライセンスの有無 |
yes |
yes |
boolean |
|||
|
spend-guard-user |
ユーザーがSpend Guardライセンスを持っているかを示します |
no |
no |
yes/no; true/false |
yes |
boolean |
|
|
sso-identifier |
ユーザーのシングルサインオンID (SSO ID) |
yes |
yes |
string(255) |
|||
|
supply-chain-user |
サプライチェーンライセンスの有無 |
yes |
yes |
boolean |
|||
|
treasury_user |
財務ライセンスの有無 |
yes |
yes |
boolean |
|||
|
updated-at |
CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します |
yes |
datetime |
||||
|
updated-by |
更新したユーザー |
yes |
ユーザー |
||||
|
user-groups |
ユーザーグループ |
yes |
yes |
||||
|
work-confirmation-approval-limit |
work_confirmation_approval_limit |
yes |
承認限度 |
||||
|
working-warehouses |
勤務倉庫 |
yes |
yes |
倉庫 |
|||
|
account-groups |
ユーザーがアクセスする必要があるアカウントグループ(アカウントベースのドキュメントセキュリティ用) |
yes |
yes |
||||
|
allow-employee-payment-account-creation |
従業員支払方法に関係なく、ユーザーが従業員支払アカウントを作成できるようにする |
はい/いいえ |
yes |
yes |
boolean |
||
|
allow-user-to-upload-invoice-from-mobile |
Coupa Mobileから請求書受信トレイに請求書画像をアップロードできるようにする |
yes |
yes |
boolean |
|||
|
legal-entity |
ユーザーを法人に割り当て、経費レポートの領収書の保持に関する要件を設定する。 |
yes |
yes |
||||
|
invoice-self-approval-limit |
請求書の自己承認上限 |
yes |
|||||
|
travel-user |
旅費ライセンスの有無 |
yes |
yes |
boolean |
|||
|
middlename |
ミドルネーム |
yes |
yes |
string(255) |
|||
|
msp_user |
ユーザーがMSPタイプかどうかを示すブール値 |
yes |
boolean |
||||