機械翻訳について

移動先

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

アプリケーションの作成

post

/api/v2/applications/

次のアプリケーション・フィールドを指定してこのリソースに対してPOSTリクエストを行って、新しいアプリケーションを作成します。

• name: このアプリケーションの名前。(文字列、必須)

• description: このアプリケーションのオプションの説明。(文字列、デフォルト="")

• client_type: クライアント・デバイスの安全性に応じて、パブリックまたは機密に設定します。(選択、必須)

  • confidential: 機密
  • public: パブリック
• redirect_uris: 許可されているURIリスト、スペース区切り(文字列、デフォルト="")
• authorization_grant_type: このアプリケーションのトークンを取得するためにユーザーが使用する必要がある付与タイプ。(選択、必須)
  • authorization-code: 認可コード
  • password: リソース所有者のパスワードベース
• skip_authorization: Trueに設定すると、完全に信頼できるアプリケーションの認可ステップをスキップします。(ブール、デフォルト=False)
• organization: このアプリケーションを含む組織。(id、必須)

リクエスト

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

• application/json

本文()

ルート・スキーマ : OAuth2Application

型: object

ソースを表示

• authorization_grant_type(required): string
  タイトル: Authorization Grant Type

  指定できる値: [ "authorization-code", "password" ]

  ユーザーがこのアプリケーションのトークンの取得に使用する必要がある権限付与タイプ。
• client_id: string
  タイトル: Client id

  読取り専用: true

  最小長: 1
• client_secret: string
  タイトル: Client Secret

  読取り専用: true

  最小長: 1

  トークンの作成時にアプリケーションへのアクセスをより厳密に検証するために使用されます。
• client_type(required): string
  タイトル: Client Type

  指定できる値: [ "confidential", "public" ]

  クライアント・デバイスのセキュリティ保護方法に応じて、パブリックまたは機密に設定します。
• created: string
  タイトル: Created

  読取り専用: true
• description: string
  タイトル: Description
• id: integer
  タイトル: Id

  読取り専用: true
• modified: string
  タイトル: Modified

  読取り専用: true
• name(required): string
  タイトル: Name

  最大長: 255
• organization(required): integer
  タイトル: Organization

  このアプリケーションを含む組織。
• redirect_uris: string
  タイトル: Redirect URIs

  許可されたURIリスト、スペース区切り
• related: string
  タイトル: Related

  読取り専用: true
• skip_authorization: boolean
  タイトル: Skip Authorization

  Trueを設定すると、完全に信頼できるアプリケーションの承認ステップをスキップできます。
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "authorization_grant_type":{
            "description":"The Grant type the user must use for acquire tokens for this application.",
            "enum":[
                "authorization-code",
                "password"
            ],
            "title":"Authorization Grant Type",
            "type":"string",
            "x-nullable":true
        },
        "client_id":{
            "minLength":"1",
            "readOnly":true,
            "title":"Client id",
            "type":"string",
            "x-nullable":true
        },
        "client_secret":{
            "description":"Used for more stringent verification of access to an application when creating a token.",
            "minLength":"1",
            "readOnly":true,
            "title":"Client Secret",
            "type":"string",
            "x-nullable":true
        },
        "client_type":{
            "description":"Set to Public or Confidential depending on how secure the client device is.",
            "enum":[
                "confidential",
                "public"
            ],
            "title":"Client Type",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"Id",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"255",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"Organization containing this application.",
            "title":"Organization",
            "type":"integer"
        },
        "redirect_uris":{
            "description":"Allowed URIs list, space separated",
            "title":"Redirect URIs",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "skip_authorization":{
            "description":"Set True to skip authorization step for completely trusted applications.",
            "title":"Skip Authorization",
            "type":"boolean",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "client_type",
        "authorization_grant_type",
        "organization"
    ],
    "type":"object"
}

先頭に戻る

レスポンス

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

• application/json

201レスポンス

本文()

ルート・スキーマ : OAuth2Application

型: object

ソースを表示

• authorization_grant_type(required): string
  タイトル: Authorization Grant Type

  指定できる値: [ "authorization-code", "password" ]

  ユーザーがこのアプリケーションのトークンの取得に使用する必要がある権限付与タイプ。
• client_id: string
  タイトル: Client id

  読取り専用: true

  最小長: 1
• client_secret: string
  タイトル: Client Secret

  読取り専用: true

  最小長: 1

  トークンの作成時にアプリケーションへのアクセスをより厳密に検証するために使用されます。
• client_type(required): string
  タイトル: Client Type

  指定できる値: [ "confidential", "public" ]

  クライアント・デバイスのセキュリティ保護方法に応じて、パブリックまたは機密に設定します。
• created: string
  タイトル: Created

  読取り専用: true
• description: string
  タイトル: Description
• id: integer
  タイトル: Id

  読取り専用: true
• modified: string
  タイトル: Modified

  読取り専用: true
• name(required): string
  タイトル: Name

  最大長: 255
• organization(required): integer
  タイトル: Organization

  このアプリケーションを含む組織。
• redirect_uris: string
  タイトル: Redirect URIs

  許可されたURIリスト、スペース区切り
• related: string
  タイトル: Related

  読取り専用: true
• skip_authorization: boolean
  タイトル: Skip Authorization

  Trueを設定すると、完全に信頼できるアプリケーションの承認ステップをスキップできます。
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "authorization_grant_type":{
            "description":"The Grant type the user must use for acquire tokens for this application.",
            "enum":[
                "authorization-code",
                "password"
            ],
            "title":"Authorization Grant Type",
            "type":"string",
            "x-nullable":true
        },
        "client_id":{
            "minLength":"1",
            "readOnly":true,
            "title":"Client id",
            "type":"string",
            "x-nullable":true
        },
        "client_secret":{
            "description":"Used for more stringent verification of access to an application when creating a token.",
            "minLength":"1",
            "readOnly":true,
            "title":"Client Secret",
            "type":"string",
            "x-nullable":true
        },
        "client_type":{
            "description":"Set to Public or Confidential depending on how secure the client device is.",
            "enum":[
                "confidential",
                "public"
            ],
            "title":"Client Type",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"Id",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"255",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"Organization containing this application.",
            "title":"Organization",
            "type":"integer"
        },
        "redirect_uris":{
            "description":"Allowed URIs list, space separated",
            "title":"Redirect URIs",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "skip_authorization":{
            "description":"Set True to skip authorization step for completely trusted applications.",
            "title":"Skip Authorization",
            "type":"boolean",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "client_type",
        "authorization_grant_type",
        "organization"
    ],
    "type":"object"
}

先頭に戻る