ジャンプ先

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

ORDS OAuthクライアントの作成

POST

/ords/rest/clients/

ORDS OAuthクライアントを作成します。

リクエスト

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

• application/json

本文 ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• allowed_origins(optional): string
  URLの接頭辞のカンマ区切りリスト。リストが空の場合、既存のオリジンは削除されます。
• description(optional): string
  クライアントの目的の説明で、Three-Legged OAuthの承認フェーズでエンド・ユーザーに表示されます。p_grant_typeがclient_credentialsの場合はnullにもできます。それ以外の場合はnullにはできません。
• logo_data(optional): string
  表示コードで使用するbase64形式のイメージ。
• logo_type(optional): string
  表示コードで使用されるロゴ・イメージの拡張子。
• name: string
  クライアントの名前で、Three-Legged OAuthの承認フェーズでエンド・ユーザーに表示されます。一意である必要があります。
• privilege_names: string
  クライアントがアクセスするカンマ区切りの権限のリストです。
• redirect_uri(optional): string
  OAuthアクセス・トークンまたはエラーが含まれるリダイレクトが送信されるクライアント制御URIです。p_grant_typeがclient_credentialsの場合はnullにもできます。それ以外の場合はnullにはできません。
• role_names(optional): string
  権限名の文字列です。
• support_email(optional): string
  エンド・ユーザーがサポートを得るためにクライアントに連絡できる電子メールです。
• support_uri(optional): string
  エンド・ユーザーがサポートを得るためにクライアントに連絡できるURIです。

{
    "type":"object",
    "required":[
        "name",
        "privilege_names"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name for the client, displayed to the end user during the approval phase of three-legged OAuth. Must be unique."
        },
        "description":{
            "type":"string",
            "description":"Description of the purpose of the client, displayed to the end user during the approval phase of three-legged OAuth. May be null if p_grant_type is client_credentials; otherwise, must not be null."
        },
        "allowed_origins":{
            "type":"string",
            "description":"A comma-separated list of URL prefixes. If the list is empty, any existing origins are removed."
        },
        "redirect_uri":{
            "type":"string",
            "description":"Client-controlled URI to which redirect containing an OAuth access token or error will be sent. May be null if p_grant_type is client_credentials; otherwise, must not be null."
        },
        "privilege_names":{
            "type":"string",
            "description":"List of comma-separated privileges that the client wants to access."
        },
        "role_names":{
            "type":"string",
            "description":"Is a string of privilege names"
        },
        "support_email":{
            "type":"string",
            "description":"The email where end users can contact the client for support."
        },
        "support_uri":{
            "type":"string",
            "description":"The URI where end users can contact the client for support."
        },
        "logo_type":{
            "type":"string",
            "description":"the extension of the logo image to be used in the show code."
        },
        "logo_data":{
            "type":"string",
            "description":"the image in base64 format for use in the show code."
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

201レスポンス

正常に作成されたORDS OAuthクライアントの詳細。

本文 ()

ルート・スキーマ: ResourceItem

タイプ: object

使用可能なその他のプロパティ: true

ソースの表示

• links(optional): array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkRelation"
    }
}

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

タイプ: object

ソースの表示

• href: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

400 レスポンス

名前、説明またはsupport_emailパラメータが指定されていないか、ロール名または権限名が存在しないか、許可されたオリジンまたは権限名のリストが大きすぎるか、権限名が長すぎます。

409レスポンス

その名前のOAuthクライアントはすでに存在します。

先頭に戻る