🌐
アカウント制御API
YESODアカウント棚卸の情報をAPI経由で取得することができます。アカウント棚卸APIの仕様について記載します。
リクエスト
エンドポイント
クエリパラメータ
必要なし
リクエストヘッダ
リクエストボディ
空
サンプル
参考：アクセストークンの取得方法は
レスポンス
ステータスコード
200 OK
レスポンスボディ（TBD）
| フィールド | |
| accounts[] | accountInfoオブジェクト |
サンプル
オブジェクト
accountInfoオブジェクト
| フィールド | |
| entityId | string アカウントに該当する従業員のEntity ID。名寄せできなかった場合は項目が返ってこない。 |
| string アカウントのメールアドレス 。GitHubなどメールアドレスの取得ができないサービスではアカウント名が返る。 | |
| fullname | string アカウントの氏名。棚卸起点となる契約SaaSで取得した値が入る。値が存在しない場合はnullで返る。 |
| notice | string アカウントに関する注意書き。 • emailのドメインが棚卸起点となる契約SaaSと一致しているのに棚卸起点となる契約SaaSに存在しない ⇒ “現存しないアカウント” • emailのドメインが棚卸起点となる契約SaaSと一致していない ⇒ “ドメイン外のアカウント” • emailがGitHubなどメールアドレスの取得ができないサービスでアカウント名になっている ⇒ “（該当する契約SaaSの表示名）アカウント” |
| belonging | accountInfoBelongingオブジェクト アカウントの存在するSaaSと所属しているロール・グループ情報。 |
accountInfoBelongingオブジェクト
| フィールド | |
| connectionId | string 契約SaaSのYESOD上のID。 |
| name | string 契約SaaSのYESOD上の表示名。 |
| invited | boolean 契約SaaS上で招待中のアカウントか否か。 |
| roles | string[] 契約SaaS上で所属しているロールの名称。どのロールにも所属していない場合は空で返る。 |
| groups | string[] 契約SaaS上で所属しているグループの名称。どのグループにも所属していない場合は空で返る。 マスタとなっている契約SaaS以外は返ってこない。 |