@@ -127,6 +127,13 @@ components:
127127 required: true
128128 schema:
129129 type: string
130+ ApplicationKeyId:
131+ description: The ID of the app key
132+ in: path
133+ name: app_key_id
134+ required: true
135+ schema:
136+ type: string
130137 ApplicationKeyIncludeParameter:
131138 description: Resource path for related resources to include in the response.
132139 Only `owned_by` is supported.
@@ -2359,6 +2366,26 @@ components:
23592366 type: string
23602367 x-enum-varnames:
23612368 - DEPLOYMENT
2369+ AppKeyRegistrationData:
2370+ description: Data related to the app key registration.
2371+ properties:
2372+ id:
2373+ description: The app key registration identifier
2374+ readOnly: true
2375+ type: string
2376+ type:
2377+ $ref: '#/components/schemas/AppKeyRegistrationDataType'
2378+ required:
2379+ - type
2380+ type: object
2381+ AppKeyRegistrationDataType:
2382+ description: The definition of `AppKeyRegistrationDataType` object.
2383+ enum:
2384+ - app_key_registration
2385+ example: app_key_registration
2386+ type: string
2387+ x-enum-varnames:
2388+ - APP_KEY_REGISTRATION
23622389 AppMeta:
23632390 description: Metadata of an app.
23642391 properties:
@@ -15863,6 +15890,12 @@ components:
1586315890 data:
1586415891 $ref: '#/components/schemas/ActionConnectionData'
1586515892 type: object
15893+ GetAppKeyRegistrationResponse:
15894+ description: The response object after getting an app key registration.
15895+ properties:
15896+ data:
15897+ $ref: '#/components/schemas/AppKeyRegistrationData'
15898+ type: object
1586615899 GetAppResponse:
1586715900 description: The full app definition response object.
1586815901 properties:
@@ -19641,6 +19674,32 @@ components:
1964119674 format: int64
1964219675 type: integer
1964319676 type: object
19677+ ListAppKeyRegistrationsResponse:
19678+ description: A paginated list of app key registrations.
19679+ properties:
19680+ data:
19681+ description: An array of app key registrations.
19682+ items:
19683+ $ref: '#/components/schemas/AppKeyRegistrationData'
19684+ type: array
19685+ meta:
19686+ $ref: '#/components/schemas/ListAppKeyRegistrationsResponseMeta'
19687+ type: object
19688+ ListAppKeyRegistrationsResponseMeta:
19689+ description: The definition of `ListAppKeyRegistrationsResponseMeta` object.
19690+ properties:
19691+ total:
19692+ description: The total number of app key registrations.
19693+ example: 1
19694+ format: int64
19695+ type: integer
19696+ total_filtered:
19697+ description: The total number of app key registrations that match the specified
19698+ filters.
19699+ example: 1
19700+ format: int64
19701+ type: integer
19702+ type: object
1964419703 ListApplicationKeysResponse:
1964519704 description: Response for a list of application keys.
1964619705 properties:
@@ -29256,6 +29315,12 @@ components:
2925629315 x-enum-varnames:
2925729316 - ANY
2925829317 - ALL
29318+ RegisterAppKeyResponse:
29319+ description: The response object after creating an app key registration.
29320+ properties:
29321+ data:
29322+ $ref: '#/components/schemas/AppKeyRegistrationData'
29323+ type: object
2925929324 RelationAttributes:
2926029325 description: Relation attributes.
2926129326 properties:
@@ -41220,6 +41285,193 @@ info:
4122041285 version: '1.0'
4122141286openapi: 3.0.0
4122241287paths:
41288+ /api/v2/actions/app_key_registrations:
41289+ get:
41290+ description: List App Key Registrations
41291+ operationId: ListAppKeyRegistrations
41292+ parameters:
41293+ - description: The number of App Key Registrations to return per page.
41294+ in: query
41295+ name: page[size]
41296+ required: false
41297+ schema:
41298+ format: int64
41299+ type: integer
41300+ - description: The page number to return.
41301+ in: query
41302+ name: page[number]
41303+ required: false
41304+ schema:
41305+ format: int64
41306+ type: integer
41307+ responses:
41308+ '200':
41309+ content:
41310+ application/json:
41311+ schema:
41312+ $ref: '#/components/schemas/ListAppKeyRegistrationsResponse'
41313+ description: Successfully listed App Key Registrations
41314+ '400':
41315+ content:
41316+ application/json:
41317+ schema:
41318+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41319+ description: Bad request
41320+ '403':
41321+ content:
41322+ application/json:
41323+ schema:
41324+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41325+ description: Forbidden
41326+ '429':
41327+ content:
41328+ application/json:
41329+ schema:
41330+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41331+ description: Too many requests
41332+ summary: List App Key Registrations
41333+ tags:
41334+ - Action Connection
41335+ x-permission:
41336+ operator: OR
41337+ permissions:
41338+ - org_app_keys_read
41339+ x-unstable: '**Note**: This endpoint is in public beta. It is not yet required
41340+ to register your App Builder, Action Connection, or Workflow Automation app
41341+ keys.'
41342+ /api/v2/actions/app_key_registrations/{app_key_id}:
41343+ delete:
41344+ description: Unregister an App Key
41345+ operationId: UnregisterAppKey
41346+ parameters:
41347+ - $ref: '#/components/parameters/ApplicationKeyId'
41348+ responses:
41349+ '204':
41350+ description: Successfully Unregistered an App Key
41351+ '400':
41352+ content:
41353+ application/json:
41354+ schema:
41355+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41356+ description: Bad request
41357+ '403':
41358+ content:
41359+ application/json:
41360+ schema:
41361+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41362+ description: Forbidden
41363+ '404':
41364+ content:
41365+ application/json:
41366+ schema:
41367+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41368+ description: Not found
41369+ '429':
41370+ content:
41371+ application/json:
41372+ schema:
41373+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41374+ description: Too many requests
41375+ summary: Unregister an App Key
41376+ tags:
41377+ - Action Connection
41378+ x-permission:
41379+ operator: OR
41380+ permissions:
41381+ - user_access_manage
41382+ - user_app_keys
41383+ - service_account_write
41384+ x-unstable: '**Note**: This endpoint is in public beta. It is not yet required
41385+ to register your App Builder, Action Connection, or Workflow Automation app
41386+ keys.'
41387+ get:
41388+ description: Get an existing App Key Registration
41389+ operationId: GetAppKeyRegistration
41390+ parameters:
41391+ - $ref: '#/components/parameters/ApplicationKeyId'
41392+ responses:
41393+ '200':
41394+ content:
41395+ application/json:
41396+ schema:
41397+ $ref: '#/components/schemas/GetAppKeyRegistrationResponse'
41398+ description: Successfully got an App Key Registration
41399+ '400':
41400+ content:
41401+ application/json:
41402+ schema:
41403+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41404+ description: Bad request
41405+ '403':
41406+ content:
41407+ application/json:
41408+ schema:
41409+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41410+ description: Forbidden
41411+ '404':
41412+ content:
41413+ application/json:
41414+ schema:
41415+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41416+ description: Not found
41417+ '429':
41418+ content:
41419+ application/json:
41420+ schema:
41421+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41422+ description: Too many requests
41423+ summary: Get an existing App Key Registration
41424+ tags:
41425+ - Action Connection
41426+ x-permission:
41427+ operator: OR
41428+ permissions:
41429+ - org_app_keys_read
41430+ x-unstable: '**Note**: This endpoint is in public beta. It is not yet required
41431+ to register your App Builder, Action Connection, or Workflow Automation app
41432+ keys.'
41433+ put:
41434+ description: Register a new App Key
41435+ operationId: RegisterAppKey
41436+ parameters:
41437+ - $ref: '#/components/parameters/ApplicationKeyId'
41438+ responses:
41439+ '201':
41440+ content:
41441+ application/json:
41442+ schema:
41443+ $ref: '#/components/schemas/RegisterAppKeyResponse'
41444+ description: Successfully registered an App Key
41445+ '400':
41446+ content:
41447+ application/json:
41448+ schema:
41449+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41450+ description: Bad request
41451+ '403':
41452+ content:
41453+ application/json:
41454+ schema:
41455+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41456+ description: Forbidden
41457+ '429':
41458+ content:
41459+ application/json:
41460+ schema:
41461+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41462+ description: Too many requests
41463+ summary: Register a new App Key
41464+ tags:
41465+ - Action Connection
41466+ x-permission:
41467+ operator: OR
41468+ permissions:
41469+ - user_access_manage
41470+ - user_app_keys
41471+ - service_account_write
41472+ x-unstable: '**Note**: This endpoint is in public beta. It is not yet required
41473+ to register your App Builder, Action Connection, or Workflow Automation app
41474+ keys.'
4122341475 /api/v2/actions/connections:
4122441476 post:
4122541477 description: Create a new Action Connection
0 commit comments