getCustomRole - API Docs

listCustomRolesで取得したカスタムロールのIDを使用して本エンドポイントにリクエストを送ることで、カスタムロールの詳細情報を取得できます。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Pathパラメータ

string

必須

カスタムロールのIDを指定します。

サンプル値:

00000000-0000-0000-0000-102101ec7001

Headerパラメータ

string

必須

サンプル値:

application/json

Authorization

string

必須

Basic認証を利用します。値にはBasicの後にスペースとBase64でエンコードされた{API key ID}:{API key secret}を利用します。

サンプル値:

Basic <Base64-encoded-credentials>

Host

string

必須

UAT環境をご利用の場合はmanagement-api-uat.smartpost.jpを指定してください。

サンプル値:

User-Agent

string

必須

サンプル値:

Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Response

🟢200Success

application/json

Body

string

必須

カスタムロールの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

account_id

string

必須

カスタムロールが属するアカウントの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

name

string

必須

カスタムロール名です。

<= 255 文字列

サンプル値:

sample custom role name

description

string

可選

カスタムロールの説明です。

サンプル値:

sample description

created_by

string

必須

カスタムロールを作成した管理者のIDです。

サンプル値:

00000000-0000-0000-0000-acc000000001

created_at

integer

必須

カスタムロールが作成された時刻（UNIX時間）です。

サンプル値:

1667899934

custom_policy_id

string

必須

カスタムロールに紐づいているカスタムポリシーのIDです。

サンプル値:

00000000-0000-0000-0000-acc000000001

custom_policy_name

string

必須

カスタムロールに紐づいているカスタムポリシー名です。

サンプル値:

sample custom policy name

related_admins

array [object {7}]

可選

カスタムロールに紐づいている管理者です。

string

必須

管理者の識別子です。

サンプル値:

00000000-0000-0000-0000-ad1110000001

string <email>

必須

管理者のメールアドレスです。

サンプル値:

t-kurosu@example.com

last_name

string

必須

管理者の姓です。

<= 100 文字列

サンプル値:

Kurosu

first_name

string

可選

管理者の名です。

<= 100 文字列

サンプル値:

Taro

role_type

integer

必須

管理者に登録されたロールのタイプに対応した数字です。
数字に対応するロールのタイプは以下のとおりです。
1: オーナー
2: 承認者
3: メンバー
4: カスタムロール

サンプル値:

status

integer

必須

管理者の招待ステータスに対応した数字です。
数字に対応する招待ステータスは以下のとおりです。
1: 登録済み（初回ログイン済み）
2: 招待中

サンプル値:

is_disabled

boolean

必須

管理者の無効化ステータスです。現在はSmartPOST運営者のみがこのステータスを変更可能です。
true: 無効
false: 有効

サンプル値:

false

例

{
    "id": "00000000-0000-0000-0000-acc000000001",
    "account_id": "00000000-0000-0000-0000-acc000000001",
    "name": "sample custom role name",
    "description": "sample description",
    "created_by": "00000000-0000-0000-0000-acc000000001",
    "created_at": 1667899934,
    "custom_policy_id": "00000000-0000-0000-0000-acc000000001",
    "custom_policy_name": "sample custom policy name",
    "related_admins": [
        {
            "id": "00000000-0000-0000-0000-ad1110000001",
            "email": "t-kurosu@example.com",
            "last_name": "Kurosu",
            "first_name": "Taro",
            "role_type": 1,
            "status": 1,
            "is_disabled": false
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found