@@ -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:
@@ -41219,6 +41284,193 @@ info:
4121941284 version: '1.0'
4122041285openapi: 3.0.0
4122141286paths:
41287+ /api/v2/actions/app_key_registrations:
41288+ get:
41289+ description: List App Key Registrations
41290+ operationId: ListAppKeyRegistrations
41291+ parameters:
41292+ - description: The number of App Key Registrations to return per page.
41293+ in: query
41294+ name: page[size]
41295+ required: false
41296+ schema:
41297+ format: int64
41298+ type: integer
41299+ - description: The page number to return.
41300+ in: query
41301+ name: page[number]
41302+ required: false
41303+ schema:
41304+ format: int64
41305+ type: integer
41306+ responses:
41307+ '200':
41308+ content:
41309+ application/json:
41310+ schema:
41311+ $ref: '#/components/schemas/ListAppKeyRegistrationsResponse'
41312+ description: Successfully listed App Key Registrations
41313+ '400':
41314+ content:
41315+ application/json:
41316+ schema:
41317+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41318+ description: Bad request
41319+ '403':
41320+ content:
41321+ application/json:
41322+ schema:
41323+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41324+ description: Forbidden
41325+ '429':
41326+ content:
41327+ application/json:
41328+ schema:
41329+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41330+ description: Too many requests
41331+ summary: List App Key Registrations
41332+ tags:
41333+ - Action Connection
41334+ x-permission:
41335+ operator: OR
41336+ permissions:
41337+ - org_app_keys_read
41338+ x-unstable: '**Note**: This endpoint is in public beta. It is not yet required
41339+ to register your App Builder, Action Connection, or Workflow Automation app
41340+ keys.'
41341+ /api/v2/actions/app_key_registrations/{app_key_id}:
41342+ delete:
41343+ description: Unregister an App Key
41344+ operationId: UnregisterAppKey
41345+ parameters:
41346+ - $ref: '#/components/parameters/ApplicationKeyId'
41347+ responses:
41348+ '204':
41349+ description: Successfully Unregistered an App Key
41350+ '400':
41351+ content:
41352+ application/json:
41353+ schema:
41354+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41355+ description: Bad request
41356+ '403':
41357+ content:
41358+ application/json:
41359+ schema:
41360+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41361+ description: Forbidden
41362+ '404':
41363+ content:
41364+ application/json:
41365+ schema:
41366+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41367+ description: Not found
41368+ '429':
41369+ content:
41370+ application/json:
41371+ schema:
41372+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41373+ description: Too many requests
41374+ summary: Unregister an App Key
41375+ tags:
41376+ - Action Connection
41377+ x-permission:
41378+ operator: OR
41379+ permissions:
41380+ - user_access_manage
41381+ - user_app_keys
41382+ - service_account_write
41383+ x-unstable: '**Note**: This endpoint is in public beta. It is not yet required
41384+ to register your App Builder, Action Connection, or Workflow Automation app
41385+ keys.'
41386+ get:
41387+ description: Get an existing App Key Registration
41388+ operationId: GetAppKeyRegistration
41389+ parameters:
41390+ - $ref: '#/components/parameters/ApplicationKeyId'
41391+ responses:
41392+ '200':
41393+ content:
41394+ application/json:
41395+ schema:
41396+ $ref: '#/components/schemas/GetAppKeyRegistrationResponse'
41397+ description: Successfully got an App Key Registration
41398+ '400':
41399+ content:
41400+ application/json:
41401+ schema:
41402+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41403+ description: Bad request
41404+ '403':
41405+ content:
41406+ application/json:
41407+ schema:
41408+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41409+ description: Forbidden
41410+ '404':
41411+ content:
41412+ application/json:
41413+ schema:
41414+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41415+ description: Not found
41416+ '429':
41417+ content:
41418+ application/json:
41419+ schema:
41420+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41421+ description: Too many requests
41422+ summary: Get an existing App Key Registration
41423+ tags:
41424+ - Action Connection
41425+ x-permission:
41426+ operator: OR
41427+ permissions:
41428+ - org_app_keys_read
41429+ x-unstable: '**Note**: This endpoint is in public beta. It is not yet required
41430+ to register your App Builder, Action Connection, or Workflow Automation app
41431+ keys.'
41432+ put:
41433+ description: Register a new App Key
41434+ operationId: RegisterAppKey
41435+ parameters:
41436+ - $ref: '#/components/parameters/ApplicationKeyId'
41437+ responses:
41438+ '201':
41439+ content:
41440+ application/json:
41441+ schema:
41442+ $ref: '#/components/schemas/RegisterAppKeyResponse'
41443+ description: Successfully registered an App Key
41444+ '400':
41445+ content:
41446+ application/json:
41447+ schema:
41448+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41449+ description: Bad request
41450+ '403':
41451+ content:
41452+ application/json:
41453+ schema:
41454+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41455+ description: Forbidden
41456+ '429':
41457+ content:
41458+ application/json:
41459+ schema:
41460+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41461+ description: Too many requests
41462+ summary: Register a new App Key
41463+ tags:
41464+ - Action Connection
41465+ x-permission:
41466+ operator: OR
41467+ permissions:
41468+ - user_access_manage
41469+ - user_app_keys
41470+ - service_account_write
41471+ x-unstable: '**Note**: This endpoint is in public beta. It is not yet required
41472+ to register your App Builder, Action Connection, or Workflow Automation app
41473+ keys.'
4122241474 /api/v2/actions/connections:
4122341475 post:
4122441476 description: Create a new Action Connection
0 commit comments