ジャンプ先

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

指定のドメインについて取得した登録トークンを使用してクライアントを登録する

投稿

/oauth2/rest/dcr/client

リクエスト

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

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

問合せパラメータ

• identityDomain(optional): string
  これは、'X-OAUTH-IDENTITY-DOMAIN-NAME'ヘッダー・パラメータの代替です。指定した場合、'X-OAUTH-IDENTITY-DOMAIN-NAME'は不要です。'X-OAUTH-IDENTITY-DOMAIN-NAME'は'identityDomain'問合せパラメータより優先されます。

ヘッダー・パラメータ

• Autherization: string
  初期アクセス・トークン
• X-OAUTH-IDENTITY-DOMAIN-NAME: string
  クライアントを登録する対象のドメイン名。これは、トークンが取得されるドメイン名と同じである必要があります

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

初期アクセス・トークン

本文()

ルート・スキーマ: clientinfo

型: object

ソースを表示

• client_get_uri: string
  クライアントの詳細をフェッチできるURI
• client_id: string
  a7befc996f674ac38720a2b64ff388e4
• client_name: string
  oma4ac38720a2b64ff388e4
• client_secret: string
  oudA8WlqpENkEz
• client_secret_expires_at(optional): integer
  時間(秒)
• redirect_uris: array redirect_uris

{
    "type":"object",
    "required":[
        "client_id",
        "client_secret",
        "client_name",
        "redirect_uris",
        "client_secrete_expires_at",
        "client_get_uri"
    ],
    "properties":{
        "client_id":{
            "type":"string",
            "description":"a7befc996f674ac38720a2b64ff388e4"
        },
        "client_secret":{
            "type":"string",
            "description":"oudA8WlqpENkEz"
        },
        "client_name":{
            "type":"string",
            "description":"oma4ac38720a2b64ff388e4"
        },
        "redirect_uris":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"android-app://com.example.app/example.com/my/path/to/information, http://localhost:8080/my/path/to/information"
            }
        },
        "client_secret_expires_at":{
            "type":"integer",
            "description":"time in sec"
        },
        "client_get_uri":{
            "type":"string",
            "description":"uri at which you can fetch the client details"
        }
    }
}

ネストされたスキーマ: redirect_uris

型: array

ソースを表示

• 配列: 文字列
  android-app://com.example.app/example.com/my/path/to/information, http://localhost:8080/my/path/to/information

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"android-app://com.example.app/example.com/my/path/to/information, http://localhost:8080/my/path/to/information"
    }
}

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レスポンス

このエラーが発生するシナリオの1つは、同じ初期アクセス・トークンを複数回使用する場合です

本文()

ルート・スキーマ: errorresponse

型: object

ソースを表示

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

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

先頭に戻る