SmartPOSTの公開APIドキュメントです。

getAdmin

GET

/v1/admins/{id}

listAdminsで取得した管理者のIDを使用して本エンドポイントにリクエストを送ることで、管理者の詳細情報を取得できます。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBasicの後にスペースと、Base64でエンコードされたusername:passwordが連結されます

例：

Authorization: Basic *****************

Pathパラメータ

Headerパラメータ

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://management-api.smartpost.jp/v1/admins/00000000-0000-0000-0000-102101ec7001' \
--header 'Accept: application/json' \
--header 'Host: management-api.smartpost.jp' \
--header 'User-Agent: Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion' \
--header 'Authorization: Basic Og=='

Response

🟢200Success

application/json

Body

例

{
    "id": "00000000-0000-0000-0000-ad1110000001",
    "account_id": "00000000-0000-0000-0000-acc000000001",
    "email": "t-kurosu@example.com",
    "last_name": "Kurosu",
    "first_name": "Taro",
    "role_type": 1,
    "status": 1,
    "login_at": 1667899934,
    "invited_by": "00000000-0000-0000-0000-ad1110000000",
    "created_at": 1667899934,
    "updated_by": "00000000-0000-0000-0000-ad1110000000",
    "updated_at": 1667899934,
    "is_disabled": false,
    "role_name": "オーナー",
    "groups": [
        {
            "id": "00000000-0000-0000-0000-acc000000001",
            "name": "sample group name"
        }
    ],
    "group_names": [
        "sample group name 1",
        "sample group name 2",
        "sample group name 3"
    ],
    "prefecture": "黒須県",
    "city": "黒須市",
    "xid_connected": "true"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

更新日時 2025-03-27 01:11:41

listAdmins

listCustomPolicies