JetBrains Space ヘルプ

アプリケーション

アプリケーションの作成

post /api/http/applications

新しいアプリケーションを作成します。このエンドポイントを使用して Marketplace アプリケーションをインストールすることはできません。

複数組織アプリケーションを作成するには (そしてアプリケーションサーバーを現在の Space インスタンスに接続するには)、connectToSpace = true を渡します。複数組織アプリケーションの詳細については、ドキュメントを参照してください。

必須アクセス権: Create applications

リクエスト引数

フィールドを持つオブジェクト :

  • name : string (必須)

    表示されるアプリケーション名

  • description : string ( Nullable および Optional、デフォルトは null)

    アプリケーションの目的の説明

  • pictureAttachmentId : string ( Nullable および Optional、デフォルトは null)

    イメージ添付ファイルの識別子。イメージをアップロードすると、イメージ添付ファイル ID を取得できます。「アップロード URL の作成」を参照してください。

  • defaultExternalPicture : string ( Nullable および Optional、デフォルトは null)

    アプリアイコンとして使用するイメージの URL

  • email : string ( Nullable および Optional、デフォルトは null)

    Git コミット検証中に使用されるメール。アプリケーション作成時にのみ指定できます。

  • clientId : string ( Nullable および Optional、デフォルトは null)

    このパラメーターを省略すると、clientId が自動的に生成されます。アプリケーションの clientId が応答として返されます

  • clientSecret : string ( Nullable および Optional、デフォルトは null)

    このパラメーターを省略すると、clientSecret が自動的に生成されます。アプリケーションの clientSecret は、Get Client Secret エンドポイントを通じて取得できます。

  • clientCredentialsFlowEnabled : boolean ( Nullable および Optional、デフォルトは true)

    クライアント認証情報フローはデフォルトで有効になっています。アプリケーションが他のフローのみを使用する場合は、false を渡します。

  • codeFlowEnabled : boolean ( Nullable および Optional、デフォルトは false)

    true を渡して、アプリケーションの認証コードフローを有効にします。詳細については、ドキュメントを参照してください。

  • codeFlowRedirectURIs : string ( Nullable および Optional、デフォルトは null)

    認可コードフローが有効な場合、フローで使用できるリダイレクト URI を指定します。詳細については、ドキュメントを参照してください。

  • pkceRequired : boolean ( Nullable および Optional、デフォルトは null)

    認証コードフローが有効な場合、PKCE 拡張機能を使用する必要があるかどうかを指定します。詳細については、ドキュメントを参照してください。

  • publicClientsAllowed : boolean ( Nullable および Optional、デフォルトは null)

    認証コードフローが有効な場合、クライアントがクライアントシークレットなしで認証できるかどうかを指定します。PKCE が必要です。詳細については、ドキュメントを参照してください。

  • implicitFlowEnabled : boolean ( Nullable および Optional、デフォルトは false)

  • implicitFlowRedirectURIs : string ( Nullable および Optional、デフォルトは null)

  • endpointUri : string ( Nullable および Optional、デフォルトは null)

    Space は、この URL を使用してペイロード ( InitPayload など) をアプリケーションに送信します。

    これは、Webhook リクエスト (WebhookRequestPayload) のデフォルト URL でもあります。Webhook リクエストの URL は Webhook ごとに再定義できます。

  • endpointSslVerification : boolean ( Nullable および Optional、デフォルトは null)

    SSL 検証は、アプリケーションエンドポイントで確立された接続に対してデフォルトで有効になっています。false を渡すと検証がオフになります。

  • appLevelAuth : EndpointAuthCreate ( Nullable および Optional、デフォルトは null)

    Space から送信されるペイロードが本物であることを確認するためにアプリケーションサーバーによって使用される認証のタイプ。

    Space からのペイロードには、serverUrl プロパティ (リクエストを送信する Space サーバーの URL) が含まれています。アプリケーションでの不正行為を防ぐには、リクエストの認証 (参照された Space サーバーから本当にリクエストが送信されていることを確認) が不可欠です。

  • sslKeystoreAuth : string ( Nullable および Optional、デフォルトは null)

    ペイロードをアプリケーションに送信するときに使用される SSL キーストアの名前。「管理」→「SSL キーストア」で SSL キーストアを作成できます。

  • hasSigningKey : boolean ( Nullable および Optional、デフォルトは null)

  • hasPublicKeySignature : boolean ( Nullable および Optional、デフォルトは null)

  • basicAuthUsername : string ( Nullable および Optional、デフォルトは null)

  • basicAuthPassword : string ( Nullable および Optional、デフォルトは null)

  • bearerAuthToken : string ( Nullable および Optional、デフォルトは null)

  • connectToSpace : boolean ( Nullable および Optional、デフォルトは false)

    true を渡して複数組織アプリケーションを作成し、アプリケーションサーバーを現在の Space インスタンスに接続します。詳細については、ドキュメントを参照してください。

  • state : string ( Nullable および Optional、デフォルトは null)

    connectToSpace = true を渡すと、Space は InitPayload をアプリケーションエンドポイントに送信します。state 値は InitPayload に渡されます。これを使用して、複数ステップのアプリケーションのインストールを実行します。

レスポンス

ES_App

エラーメッセージを設定する

post /api/http/applications/error-message

Space UI のアプリケーションページに表示するエラーメッセージを指定します。null メッセージを提供して削除します。

リクエスト引数

フィールドを持つオブジェクト :

  • message : string ( Nullable および Optional、デフォルトは null)

レスポンス

引数なし

アプリケーションを正常であると報告する

post /api/http/applications/report-application-as-healthy

アプリケーションはこの API メソッドを定期的に呼び出して、Space が適切に機能していることを通知できます。これは、外部の課題トラッカーに接続するアプリケーションには必須です。

リクエスト引数

引数なし

レスポンス

引数なし

アプリケーションを強制的に削除する

post /api/http/applications/{application}/force-remove

以前に ApplicationUninstalledPayload 要求に対するコード 200 での応答に失敗したアプリケーションを、追加の ApplicationUninstalledPayload 要求を送信せずに削除します。アプリケーションはアーカイブされ、アクセスが終了します。

必須アクセス権: Delete applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

強制的に削除するアプリケーションの識別子

レスポンス

引数なし

アプリケーションを復元する

post /api/http/applications/{application}/restore

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

引数なし

すべてのアプリケーションを取得する

get /api/http/applications/paged

必須アクセス権: View applications

リクエスト引数

$skip : string (クエリ) ( Nullable および Optional、デフォルトは null)

$top : integer (フォーマット: int32) (クエリ) ( Nullable および Optional、デフォルトは 100)

name : string (クエリ) ( Nullable および Optional、デフォルトは null)

owner : ProfileIdentifier の配列 (クエリ) ( Nullable および Optional、デフォルトは null)

withArchived : boolean (クエリ) ( Nullable および Optional、デフォルトは false)

withManaged : boolean (クエリ) ( Nullable および Optional、デフォルトは true)

ordering : AppsOrdering (クエリ) ( Nullable および Optional、デフォルトは null)

レスポンス

フィールドを持つオブジェクト :

  • next : string (必須)

  • totalCount : integer (フォーマット: int32) ( Nullable および Optional、デフォルトは null)

  • data : ES_App の配列 (必須)

アプリケーションを取得する

get /api/http/applications/{application}

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

ES_App

アプリケーションの更新

patch /api/http/applications/{application}

既存のアプリケーションを更新します。複数組織アプリケーション ( connectToSpace = true パラメーターを使用して作成された、または JetBrains Marketplace からインストールされた) は、アプリケーション自体によってのみ更新できます。複数組織アプリケーションの詳細については、ドキュメントを参照してください。

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

アップデートが必要なアプリケーション

フィールドを持つオブジェクト :

  • name : string (オプション)

    表示されるアプリケーション名

  • description : string (オプション)

    アプリケーションの目的の説明

  • pictureAttachmentId : string ( Null 可能かつオプション)

    イメージ添付ファイルの識別子。イメージをアップロードすると、イメージ添付ファイル ID を取得できます。「アップロード URL の作成」を参照してください。

  • defaultExternalPicture : string ( Null 可能かつオプション)

    アプリアイコンとして使用するイメージの URL

  • clientSecret : string (オプション)

    このパラメーターを渡して、アプリケーションのクライアントシークレットを更新します。クライアントシークレットは、Get Client Secret エンドポイントを通じて取得できます。

  • clientCredentialsFlowEnabled : boolean (オプション)

    クライアント資格情報フローはデフォルトで有効になっています。アプリケーションが他のフローのみを使用する場合は、フローを無効にします。

  • codeFlowEnabled : boolean (オプション)

    認証コードフローはデフォルトでは無効になっています。true を渡して、アプリケーションの認証コードフローを有効にします。詳細については、ドキュメントを参照してください。

  • codeFlowRedirectURIs : string ( Null 可能かつオプション)

    認可コードフローが有効な場合、フローで使用できるリダイレクト URI を指定します。詳細については、ドキュメントを参照してください。

  • pkceRequired : boolean (オプション)

    認証コードフローが有効な場合、PKCE 拡張機能を使用する必要があるかどうかを指定します。詳細については、ドキュメントを参照してください。

  • publicClientsAllowed : boolean (オプション)

    認証コードフローが有効な場合、クライアントがクライアントシークレットなしで認証できるかどうかを指定します。PKCE が必要です。詳細については、ドキュメントを参照してください。

  • implicitFlowEnabled : boolean (オプション)

  • implicitFlowRedirectURIs : string ( Null 可能かつオプション)

  • endpointUri : string ( Null 可能かつオプション)

    Space は、この URL を使用してペイロード ( MessagePayload など) をアプリケーションに送信します。

    これは、Webhook リクエスト (WebhookRequestPayload) のデフォルト URL でもあります。Webhook リクエストの URL は Webhook ごとに再定義できます。

  • endpointSslVerification : boolean (オプション)

    SSL 検証は、アプリケーションエンドポイントで確立された接続に対してデフォルトで有効になっています。false を渡すと検証がオフになります。

  • hasVerificationToken : boolean (オプション)

  • hasPublicKeySignature : boolean (オプション)

  • hasSigningKey : boolean (オプション)

  • appLevelAuth : EndpointAppLevelAuthUpdateType (オプション)

    Space から送信されるペイロードが本物であることを確認するためにアプリケーションサーバーによって使用される認証のタイプ。

    Space からのペイロードには、serverUrl プロパティ (リクエストを送信する Space サーバーの URL) が含まれています。アプリケーションでの不正行為を防ぐには、リクエストの認証 (参照された Space サーバーから本当にリクエストが送信されていることを確認) が不可欠です。

  • sslKeystoreAuth : string ( Null 可能かつオプション)

    ペイロードをアプリケーションに送信するときに使用される SSL キーストアの名前。「管理」→「SSL キーストア」で SSL キーストアを作成できます。

  • basicAuthUsername : string (オプション)

  • basicAuthPassword : string (オプション)

  • bearerAuthToken : string (オプション)

レスポンス

ES_App

アプリケーションの削除

delete /api/http/applications/{application}

指定されたアプリケーションを削除します。アプリケーションが接続されている場合 (マーケットプレイスまたはインストールリンクを通じてインストールされている場合)、Space はアプリケーションのサーバーに ApplicationUninstalledPayload を送信します。アプリケーションが実際に削除されるのは、アプリケーションサーバーが応答した場合、または ApplicationUninstalledPayload リクエストが複数回タイムアウトした場合のみです。

この API メソッドは、ApplicationUninstalledPayload リクエストが完了するまで待機せず、すぐに戻ります。この API メソッド呼び出しの直後、アプリケーションはまだアクティブである可能性があります。

ApplicationUninstalledPayload の送信が少なくとも 1 回失敗した場合、ユーザーはアプリケーションを強制的に削除することを選択できます。この場合、アプリケーションへのアクセスは終了し、リクエストを行うことができなくなります。

必須アクセス権: Delete applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

削除するアプリケーションの識別子

レスポンス

引数なし

無記名トークン

get /api/http/applications/{application}/bearer-token

必須アクセス権: View application secrets

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します。

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

string

最後のクライアント認証情報のアクセス情報を取得する

get /api/http/applications/{application}/last-client-credentials-access

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

AccessRecord

公開鍵

get /api/http/applications/{application}/public-keys

公開鍵のリストを JWKS 形式で返します。返された公開鍵のいずれかを使用してメッセージの署名が正常に検証された場合、そのメッセージは本物であると見なされます。

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

string

UI 拡張機能を設定する

patch /api/http/applications/ui-extensions

指定されたコンテキストで呼び出し側アプリケーションによってサポートされる UI 拡張機能を設定します。拡張子を設定できるのはアプリケーション自体だけです。

リクエスト引数

フィールドを持つオブジェクト :

レスポンス

引数なし

コンテキスト内でアプリケーションを承認する

get /api/http/applications/authorizations/authorized-applications

指定されたコンテキストで許可されたアプリケーションをリストする

必須アクセス権: View applications

リクエスト引数

contextIdentifier : いずれかの形式の文字列

(クエリ) (必須)

レスポンス

ES_App の配列

すべてのパラメーターを取得する

get /api/http/applications/parameters

すべてのアプリケーションパラメーターを返します。ユーザートークンではなく、アプリトークンでのみアクセスできます。

リクエスト引数

引数なし

レスポンス

AppParameter の配列

パラメーターの取得

get /api/http/applications/parameters/{key}

アプリケーションパラメーターをキーで取得します。ユーザートークンではなく、アプリトークンでのみアクセスできます。

リクエスト引数

key : string (パス) (必須)

レスポンス

string

パラメーターの設定

patch /api/http/applications/parameters/{key}

アプリケーションパラメーターをキーで設定します。ユーザートークンではなく、アプリトークンでのみアクセスできます。アプリごとのアプリパラメーターの制限は 100 です。キーは 64 文字を超えることはできません。値は 1000 文字を超えることはできません。

リクエスト引数

key : string (パス) (必須)

フィールドを持つオブジェクト :

  • value : string (必須)

レスポンス

引数なし

パラメーターの除去

delete /api/http/applications/parameters/{key}

アプリケーションパラメーターをキーで削除します。ユーザートークンではなく、アプリトークンでのみアクセスできます。

リクエスト引数

key : string (パス) (必須)

レスポンス

引数なし

すべてのプロファイルパラメーターを取得する

get /api/http/applications/parameters/profile

すべてのプロファイルパラメーターを返します。プロファイルとアプリケーションはアクセストークンから派生します。アプリケーションに発行されたユーザートークンでのみアクセスできます。

リクエスト引数

引数なし

レスポンス

AppParameter の配列

プロファイルパラメーターを取得する

get /api/http/applications/parameters/profile/{key}

キーによってプロファイルパラメーターを取得し、プロファイルとアプリケーションはアクセストークンから派生します。アプリケーションに発行されたユーザートークンでのみアクセスできます。

リクエスト引数

key : string (パス) (必須)

レスポンス

string

プロファイルパラメーターを設定する

patch /api/http/applications/parameters/profile/{key}

プロファイルパラメーターをキーで設定し、プロファイルとアプリケーションはアクセストークンから派生します。アプリケーションに発行されたユーザートークンでのみアクセスできます。アプリごとのプロファイルごとのアプリパラメーターの制限は 100 です。キーは 64 文字を超えることはできません。値は 1000 文字を超えることはできません。

リクエスト引数

key : string (パス) (必須)

フィールドを持つオブジェクト :

  • value : string (必須)

レスポンス

引数なし

プロファイルパラメーターを削除する

delete /api/http/applications/parameters/profile/{key}

キーによってプロファイルパラメーターを削除します。プロファイルとアプリケーションはアクセストークンから派生します。アプリケーションに発行されたユーザートークンでのみアクセスできます。

リクエスト引数

key : string (パス) (必須)

レスポンス

引数なし

展開されたドメインを更新する

patch /api/http/applications/unfurls/domains

アプリケーションによって展開されるドメインのリストを更新します。メソッドは、展開を提供するアプリケーションによって呼び出されます。

必須アクセス権: Update applications

リクエスト引数

フィールドを持つオブジェクト :

  • domains : string の配列 (必須)

レスポンス

引数なし

展開されたパターンを更新する

patch /api/http/applications/unfurls/patterns

アプリケーションによって展開される外部 ID 接頭辞のリストを更新します。メソッドは、展開を提供するアプリケーションによって呼び出されます。

必須アクセス権: Update applications

リクエスト引数

フィールドを持つオブジェクト :

レスポンス

引数なし

投稿はコンテンツを展開する

post /api/http/applications/unfurls/queue/content

展開されるコンテンツを Space に提供します。メソッドは、展開を提供するアプリケーションによって呼び出されます。

必須アクセス権: Provide external unfurls as attachments

リクエスト引数

フィールドを持つオブジェクト :

レスポンス

PostUnfurlContentResult の配列

外部システム認証を要求する

post /api/http/applications/unfurls/queue/request-external-auth

外部システムからの展開を提供するには、ユーザーに外部システムでの認証を要求します。メソッドは、展開を提供するアプリケーションによって呼び出されます。

必須アクセス権: Provide external unfurls as attachments

リクエスト引数

フィールドを持つオブジェクト :

レスポンス

引数なし

外部システム認証リクエストをクリアする

post /api/http/applications/unfurls/queue/reset-external-auth-requests

指定されたユーザーのすべての外部システム認証要求をクリアします。メソッドは、展開を提供するアプリケーションによって呼び出されます。

必須アクセス権: Provide external unfurls as attachments

リクエスト引数

フィールドを持つオブジェクト :

レスポンス

引数なし

展開キュー項目を取得する

get /api/http/applications/unfurls/queue

アプリケーションで展開するためのリンクを取得します。メソッドは、展開を提供するアプリケーションによって呼び出されます。

必須アクセス権: Provide external unfurls as attachments

リクエスト引数

fromEtag : integer (フォーマット: int64) (クエリ) ( Nullable および Optional、デフォルトは null)

batchSize : integer (フォーマット: int32) (クエリ) (必須)

レスポンス

ApplicationUnfurlQueueItem の配列

すべての許可されたコンテキストを取得する

get /api/http/applications/{application}/authorizations/authorized-contexts

アプリケーションの許可されたコンテキストをリストする

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

PermissionContextApi の配列

認可されたすべての権利を取得する

get /api/http/applications/{application}/authorizations/authorized-rights

指定されたコンテキストでアプリケーションの許可された権限をリストします

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

contextIdentifier : いずれかの形式の文字列

(クエリ) (必須)

レスポンス

RightDTO の配列

更新権限

patch /api/http/applications/{application}/authorizations/authorized-rights

特定のコンテキストで承認された権利ステータスを編集するための一般的なメソッド。

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

レスポンス

引数なし

許可された権限を削除する

delete /api/http/applications/{application}/authorizations/authorized-rights

指定されたコンテキストでアプリケーションの承認を削除します

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

contextIdentifier : いずれかの形式の文字列

(クエリ) (必須)

レスポンス

引数なし

権利を要求する

patch /api/http/applications/{application}/authorizations/authorized-rights/request-rights

指定されたコンテキストでアプリケーションの権限をリクエストする

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

レスポンス

引数なし

必要な権利をすべて取得する

get /api/http/applications/{application}/authorizations/required-rights

アプリケーションに必要な権限をリストする

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

RightDTO の配列

更新が必要な権利

patch /api/http/applications/{application}/authorizations/required-rights

アプリケーションに必要な権限のリストを更新する

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

レスポンス

引数なし

アプリシークレットを再生成する

post /api/http/applications/{application}/client-secret/regenerate

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

引数なし

クライアントシークレットを取得する

get /api/http/applications/{application}/client-secret

必須アクセス権: View application secrets

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

string

GPG キーを追加

post /api/http/applications/{application}/gpg-keys

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

  • publicKey : string (必須)

  • comment : string (オプション、デフォルトは "")

レスポンス

GpgKeyData

GPG キーを取得する

get /api/http/applications/{application}/gpg-keys

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

GpgKeyData の配列

GPG キーを取り消す

patch /api/http/applications/{application}/gpg-keys/{fingerprint}

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

fingerprint : string (パス) (必須)

フィールドを持つオブジェクト :

  • comment : string (オプション、デフォルトは "")

レスポンス

引数なし

GPG キーを削除する

delete /api/http/applications/{application}/gpg-keys/{fingerprint}

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

fingerprint : string (パス) (必須)

レスポンス

引数なし

永久トークンを作成する

post /api/http/applications/{application}/permanent-tokens

現在の組織へのアクセスに使用できる、指定されたアプリケーションの永久トークンを作成します。

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

  • name : string (必須)

  • scope : string (必須)

  • expires : string (フォーマット: 日付時刻) ( Nullable および Optional、デフォルトは null)

レスポンス

フィールドを持つオブジェクト :

すべての永久トークンを取得する

get /api/http/applications/{application}/permanent-tokens

指定されたアプリケーションによって現在の組織にアクセスするために使用される永久トークンを取得します

必須アクセス権: View application secrets

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

$skip : string (クエリ) ( Nullable および Optional、デフォルトは null)

$top : integer (フォーマット: int32) (クエリ) ( Nullable および Optional、デフォルトは 100)

レスポンス

フィールドを持つオブジェクト :

  • next : string (必須)

  • totalCount : integer (フォーマット: int32) ( Nullable および Optional、デフォルトは null)

  • data : ES_ApplicationPermanentToken の配列 (必須)

永久トークンを更新する

patch /api/http/applications/{application}/permanent-tokens/{tokenId}

現在の組織へのアクセスに使用される既存の個人トークンを更新します。永久トークンの名前やスコープは更新できます。

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

tokenId : string (パス) (必須)

フィールドを持つオブジェクト :

  • name : string ( Nullable および Optional、デフォルトは null)

  • scope : string ( Nullable および Optional、デフォルトは null)

  • expires : string (フォーマット: 日付時刻) ( Null 可能かつオプション)

レスポンス

引数なし

永久トークンを削除

delete /api/http/applications/{application}/permanent-tokens/{tokenId}

現在の組織へのアクセスに使用される個人トークンを削除する

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

tokenId : string (パス) (必須)

レスポンス

引数なし

現在の永久トークンを削除する

delete /api/http/applications/{application}/permanent-tokens/current

指定されたアプリケーションの個人トークンを削除します

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

引数なし

署名キーを再生成する

post /api/http/applications/{application}/signing-key/regenerate

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

引数なし

署名キーを取得する

get /api/http/applications/{application}/signing-key

必須アクセス権: View application secrets

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

string

SSH キーを追加する

post /api/http/applications/{application}/ssh-keys

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

  • publicKey : string (必須)

  • comment : string (必須)

レスポンス

引数なし

SSH キーを取得する

get /api/http/applications/{application}/ssh-keys

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

SshKeyData の配列

SSH キーを削除する

delete /api/http/applications/{application}/ssh-keys/{fingerprint}

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

fingerprint : string (パス) (必須)

レスポンス

引数なし

UI 拡張機能を取得する

get /api/http/applications/{application}/ui-extensions

指定されたコンテキストでアプリケーションによってサポートされている UI 拡張機能を取得します。すべてのコンテキストで UI 拡張機能を取得するには、contextIdentifier を省略します。

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

contextIdentifier : いずれかの形式の文字列

(クエリ) (必須)

レスポンス

AppUiExtensionApi の配列

アプリケーション UI を無効にする

patch /api/http/applications/{application}/ui-extensions/disable-for-everybody

指定されたコンテキスト内の全員に対してアプリケーション UI を無効にします。グローバルコンテキストには Superadmin 権限、プロジェクトコンテキストには AdminProject、チャネルコンテキストには AdminChannel 権限が必要です。ユーザーは引き続きアプリケーション UI を個別に有効にすることができます。

必須アクセス権: View applicationsGrant permissions to other membersManage project permission schemeManage channels

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

レスポンス

引数なし

アプリケーション UI を無効にする

patch /api/http/applications/{application}/ui-extensions/disable-for-me

現在のユーザーの指定されたコンテキストでアプリケーション UI を無効にする

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

レスポンス

引数なし

アプリケーション UI を有効にする

patch /api/http/applications/{application}/ui-extensions/enable-for-everybody

指定されたコンテキスト内の全員に対してアプリケーション UI を有効にします。グローバルコンテキストには Superadmin 権限、プロジェクトコンテキストには AdminProject、チャネルコンテキストには AdminChannel 権限が必要です。ユーザーは引き続きアプリケーション UI を個別に無効にすることができます。

必須アクセス権: View applicationsGrant permissions to other membersManage project permission schemeManage channels

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

レスポンス

引数なし

アプリケーション UI を有効にする

patch /api/http/applications/{application}/ui-extensions/enable-for-me

現在のユーザーの指定されたコンテキストでアプリケーション UI を有効にする

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

レスポンス

引数なし

展開されたドメインを承認する

post /api/http/applications/{application}/unfurl-domains/authorize

アプリケーションによる展開のためにドメインを承認する

必須アクセス権: Authorize domains and patterns for app-powered previews

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

  • domains : string の配列 (必須)

    リンクプレビューの提供を承認または拒否するドメインのリスト

  • approve : boolean (必須)

    提供されたドメインのリストのリンクプレビューを承認する場合は true、拒否する場合は false

レスポンス

引数なし

すべての unfurl ドメインを取得する

get /api/http/applications/{application}/unfurl-domains

アプリケーションによって展開されるドメインをリストします

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

ApplicationUnfurlDomain の配列

展開されたパターンを承認する

post /api/http/applications/{application}/unfurl-patterns/authorize

アプリケーションによる展開のパターンを承認する

必須アクセス権: Authorize domains and patterns for app-powered previews

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

  • patterns : string の配列 (必須)

    リンクプレビューの提供を承認または拒否する外部 ID 接頭辞のリスト

  • approve : boolean (必須)

    提供された外部 ID 接頭辞のリストのリンクプレビューを承認する場合は true、拒否する場合は false

レスポンス

引数なし

すべての展開パターンを取得する

get /api/http/applications/{application}/unfurl-patterns

アプリケーションによって展開されるパターンのリスト

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

ApplicationUnfurlPattern の配列

検証トークンを再生成する

post /api/http/applications/{application}/verification-token/regenerate

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

引数なし

検証トークンを取得する

get /api/http/applications/{application}/verification-token

必須アクセス権: View application secrets

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

レスポンス

string

Webhook の作成

post /api/http/applications/{application}/webhooks

アプリケーション Webhook の作成

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

フィールドを持つオブジェクト :

  • name : string (必須)

  • description : string ( Nullable および Optional、デフォルトは null)

  • endpoint : EndpointCreateDTO ( Nullable および Optional、デフォルトは null)

  • endpointAuth : EndpointAuthCreateDTO ( Nullable および Optional、デフォルトは null)

  • enabled : boolean (オプション、デフォルトは true)

  • acceptedHttpResponseCodes : integer の配列 (フォーマット: int32) (オプション、デフォルトは [])

    アプリケーションサーバーから返されたときに、Space によって成功したものとして扱われる 2xx 範囲外の HTTP ステータスコードのリスト

  • doRetries : boolean (オプション、デフォルトは true)

  • payloadFields : string ( Nullable および Optional、デフォルトは null)

  • payloadTemplate : string ( Nullable および Optional、デフォルトは null)

    payloadFields の代わりに、payloadTemplate パラメーターを指定できます。これは、HTTP 本文の自由形式のテンプレートです。テンプレート内で変数を使用できます。変数は、Webhook がトリガーされたときに実際の値に置き換えられます。変数を参照するには、構文 {{variableName}} を使用します。例: Chat Messages サブスクリプションの場合、{{message.author.name}} はメッセージの作成者の名前に置き換えられます。開始波括弧をエスケープするには、\{ を使用します。バックスラッシュをエスケープするには、\\ を使用します。利用可能な変数を調べるには、関連するサブスクリプションを使用して UI でアプリケーションの Webhook を設定し、Customize Payload セクションを参照してください。payload ノードの子は変数として使用できます。

  • subscriptions : SubscriptionDefinition の配列 ( Nullable および Optional、デフォルトは null)

レスポンス

WebhookRecord

すべての Webhook を取得する

get /api/http/applications/{application}/webhooks

アプリケーション Webhook を取得する

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

withArchived : boolean (クエリ) (オプション、デフォルトは false)

query : string (クエリ) (オプション、デフォルトは "")

$skip : string (クエリ) ( Nullable および Optional、デフォルトは null)

$top : integer (フォーマット: int32) (クエリ) ( Nullable および Optional、デフォルトは 100)

レスポンス

フィールドを持つオブジェクト :

  • next : string (必須)

  • totalCount : integer (フォーマット: int32) ( Nullable および Optional、デフォルトは null)

  • data : FullWebhookDTO の配列 (必須)

Webhook の投稿

post /api/http/applications/{application}/webhooks/{webhookId}

アーカイブされたアプリケーション Webhook を復元する

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

レスポンス

引数なし

Webhook を更新する

patch /api/http/applications/{application}/webhooks/{webhookId}

アプリケーション Webhook を更新する

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

フィールドを持つオブジェクト :

  • name : string (オプション)

  • description : string ( Null 可能かつオプション)

  • enabled : boolean (オプション)

  • endpoint : ExternalEndpointUpdateDTO ( Null 可能かつオプション)

  • endpointAuth : EndpointAuthUpdateDTO ( Null 可能かつオプション)

  • acceptedHttpResponseCodes : integer の配列 (フォーマット: int32) (オプション)

  • doRetries : boolean (オプション)

  • payloadFields : string ( Null 可能かつオプション)

  • payloadTemplate : string ( Null 可能かつオプション)

    payloadFields の代わりに、payloadTemplate パラメーターを指定できます。これは、HTTP 本文の自由形式のテンプレートです。テンプレート内で変数を使用できます。変数は、Webhook がトリガーされたときに実際の値に置き換えられます。変数を参照するには、構文 {{variableName}} を使用します。例: Chat Messages サブスクリプションの場合、{{message.author.name}} はメッセージの作成者の名前に置き換えられます。開始波括弧をエスケープするには、\{ を使用します。バックスラッシュをエスケープするには、\\ を使用します。利用可能な変数を調べるには、関連するサブスクリプションを使用して UI でアプリケーションの Webhook を設定し、Customize Payload セクションを参照してください。payload ノードの子は変数として使用できます。

レスポンス

引数なし

Webhook の削除

delete /api/http/applications/{application}/webhooks/{webhookId}

アプリケーション Webhook をアーカイブする

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

レスポンス

引数なし

無記名トークン

get /api/http/applications/{application}/webhooks/{webhookId}/bearer-token

必須アクセス権: View application secrets

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

レスポンス

string

カスタムヘッダーを投稿する

post /api/http/applications/{application}/webhooks/{webhookId}/custom-headers

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

フィールドを持つオブジェクト :

レスポンス

引数なし

カスタムヘッダーを取得する

get /api/http/applications/{application}/webhooks/{webhookId}/custom-headers

必須アクセス権: View application secrets

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

レスポンス

CustomHttpHeaderDTO の配列

再生する

post /api/http/applications/{application}/webhooks/{webhookId}/signing-key/regenerate

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

レスポンス

引数なし

署名キーを取得する

get /api/http/applications/{application}/webhooks/{webhookId}/signing-key

必須アクセス権: View application secrets

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

レスポンス

string

サブスクリプションの作成

post /api/http/applications/{application}/webhooks/{webhookId}/subscriptions

Webhook サブスクリプションを追加する

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

フィールドを持つオブジェクト :

レスポンス

SubscriptionDTO

すべてのサブスクリプションを取得する

get /api/http/applications/{application}/webhooks/{webhookId}/subscriptions

Webhook サブスクリプションを取得する

必須アクセス権: View applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

レスポンス

SubscriptionDTO の配列

不足している権利をリクエストする

post /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}/request-missing-rights

このサブスクリプションに必要なすべての権限が、対応する権限ロールで要求されていることを確認します

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

subscriptionId : string (パス) (必須)

レスポンス

引数なし

サブスクリプションを更新する

patch /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}

Webhook サブスクリプションを更新する

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

subscriptionId : string (パス) (必須)

フィールドを持つオブジェクト :

レスポンス

SubscriptionDTO

サブスクリプションの削除

delete /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}

Webhook サブスクリプションを削除する

必須アクセス権: Update applications

リクエスト引数

application : いずれかの形式の文字列

  • clientId : string

    Space での認証に使用するクライアント ID によってアプリケーションを指定します

    続きを読む

  • id : string

    すべてのアプリケーションを取得するメソッドで取得できる識別子でアプリケーションを指定します

  • me

    この API メソッドの呼び出し元に対応するアプリケーションを指定します。

    Space アプリケーションによって行われた呼び出しにのみ適用されます。

(パス) (必須)

webhookId : string (パス) (必須)

subscriptionId : string (パス) (必須)

レスポンス

引数なし