ジャンプ先

• リクエスト
• レスポンス

DCRフローを使用してOAuthクライアントの登録に使用できる初期アクセス・トークンを取得する

get

/oauth2/rest/dcr/token

トークンはJSONレスポンス形式またはQRコードで取得できます

リクエスト

サポートされているメディア・タイプ

• application/json
• application/x-www-form-urlencoded

問合せパラメータ

• domain: string
  クライアントを登録する対象のドメイン名
• identityDomain(optional): string
  これは、'domain'問合せパラメータの代替です。指定した場合、domainは必要ありません。
• output_type(optional): string
  生成されるアクセス・トークンの出力形式。現在サポートされている2つの形式は、image/pngおよびapplication/jsonです。デフォルトはapplication/jsonです
• template_id: string
  実際のクライアントの自動構成生成のために管理者によって登録されたOAuthクライアント・テンプレートのテンプレートID

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200 レスポンス

初期アクセス・トークン

本文()

ルート・スキーマ: accesstoken

型: object

ソースを表示

• access_token: string
  eyJraWQiOiJkY3JfZG9tYWluIiwieDV0IjoibnFpalFTVkNDMGVrS1
• expires_in: integer
  トークンの有効期限(秒)
• token_type: string
  Bearer

{
    "type":"object",
    "required":[
        "access_token",
        "token_type",
        "expires_in"
    ],
    "properties":{
        "access_token":{
            "type":"string",
            "description":"eyJraWQiOiJkY3JfZG9tYWluIiwieDV0IjoibnFpalFTVkNDMGVrS1"
        },
        "token_type":{
            "type":"string",
            "description":"Bearer"
        },
        "expires_in":{
            "type":"integer",
            "description":"expiry time of token in sec"
        }
    }
}

403レスポンス

現在のドメインでOAuthサービスが有効化されていないかDCRが有効化されていない場合

本文()

ルート・スキーマ: errorresponse

型: object

ソースを表示

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

404レスポンス

エラー

本文()

ルート・スキーマ: errorresponse

型: object

ソースを表示

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: errorresponse

型: object

ソースを表示

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

先頭に戻る