getCustomPolicy - API Docs

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

パスパラメータ

Headerパラメータ

リクエストコードサンプル

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location 'https://management-api.smartpost.jp/v1/custom-policies/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 <encoded-value>'

レスポンス

🟢200Success

application/json

ボディapplication/json

例

{
    "id": "00000000-0000-0000-0000-acc000000001",
    "account_id": "00000000-0000-0000-0000-acc000000001",
    "name": "sample custom policy name",
    "description": "sample description",
    "created_by": "00000000-0000-0000-0000-acc000000001",
    "created_at": 1667899934,
    "policy_setting": {
        "admin": "write",
        "policy": "write",
        "role": "write",
        "group": "write",
        "user": "read",
        "custom_user_name": "read",
        "custom_user_gender": "read",
        "custom_user_dob": "read",
        "custom_user_address": "read",
        "user_status": "write",
        "user_export": "yes",
        "user_custom_id": "read",
        "project": "write",
        "project_approve": "yes",
        "welcome_project_publish": "yes",
        "welcome_project_unpublish": "yes",
        "trail": "yes",
        "recipient": "read",
        "custom_recipient_name": "read",
        "custom_recipient_gender": "read",
        "custom_recipient_dob": "read",
        "custom_recipient_address": "read",
        "activity": "read",
        "policy_and_tos": "yes",
        "template_publish": "yes",
        "template_unpublish": "yes",
        "api_key": "read",
        "set_tester": "read",
        "send_test_message": "read"
    },
    "creator_last_name": "Kurosu",
    "creator_first_name": "Taro",
    "related_roles": [
        {
            "id": "00000000-0000-0000-0000-acc000000001",
            "name": "sample custom role name"
        }
    ],
    "related_groups": [
        {
            "id": "00000000-0000-0000-0000-acc000000001",
            "name": "sample group name"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found