Skip to content

Commit b6b4331

Browse files
clerk-cookieclerk-cookie
committed
chore: Update OpenAPI Specs
1 parent 3c57d41 commit b6b4331

File tree

4 files changed

+4899
-0
lines changed

4 files changed

+4899
-0
lines changed

‎bapi/2021-02-05.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4129,6 +4129,55 @@ paths:
41294129
$ref: '#/components/responses/AuthorizationInvalid'
41304130
'404':
41314131
$ref: '#/components/responses/ResourceNotFound'
4132+
/machines/{machine_id}/secret_key/rotate:
4133+
post:
4134+
operationId: RotateMachineSecretKey
4135+
x-speakeasy-group: machines
4136+
x-speakeasy-name-override: rotateSecretKey
4137+
summary: Rotate a machine's secret key
4138+
description: |-
4139+
Rotates the machine's secret key.
4140+
When the secret key is rotated, make sure to update it in your machine/application.
4141+
The previous secret key will remain valid for the duration specified by the previous_token_ttl parameter.
4142+
tags:
4143+
- Machines
4144+
parameters:
4145+
- name: machine_id
4146+
in: path
4147+
description: The ID of the machine to rotate the secret key for
4148+
required: true
4149+
schema:
4150+
type: string
4151+
requestBody:
4152+
required: true
4153+
content:
4154+
application/json:
4155+
schema:
4156+
type: object
4157+
required:
4158+
- previous_token_ttl
4159+
properties:
4160+
previous_token_ttl:
4161+
type: integer
4162+
minimum: 0
4163+
maximum: 28800
4164+
description: |-
4165+
The time in seconds that the previous secret key will remain valid after rotation.
4166+
This ensures a graceful transition period for updating applications with the new secret key.
4167+
Set to 0 to immediately expire the previous key. Maximum value is 8 hours (28800 seconds).
4168+
responses:
4169+
'200':
4170+
$ref: '#/components/responses/Machine.SecretKey'
4171+
'400':
4172+
$ref: '#/components/responses/ClerkErrors'
4173+
'401':
4174+
$ref: '#/components/responses/AuthenticationInvalid'
4175+
'403':
4176+
$ref: '#/components/responses/AuthorizationInvalid'
4177+
'404':
4178+
$ref: '#/components/responses/ResourceNotFound'
4179+
'422':
4180+
$ref: '#/components/responses/UnprocessableEntity'
41324181
/machines/{machine_id}/scopes:
41334182
post:
41344183
operationId: CreateMachineScope

‎bapi/2024-10-01.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4129,6 +4129,55 @@ paths:
41294129
$ref: '#/components/responses/AuthorizationInvalid'
41304130
'404':
41314131
$ref: '#/components/responses/ResourceNotFound'
4132+
/machines/{machine_id}/secret_key/rotate:
4133+
post:
4134+
operationId: RotateMachineSecretKey
4135+
x-speakeasy-group: machines
4136+
x-speakeasy-name-override: rotateSecretKey
4137+
summary: Rotate a machine's secret key
4138+
description: |-
4139+
Rotates the machine's secret key.
4140+
When the secret key is rotated, make sure to update it in your machine/application.
4141+
The previous secret key will remain valid for the duration specified by the previous_token_ttl parameter.
4142+
tags:
4143+
- Machines
4144+
parameters:
4145+
- name: machine_id
4146+
in: path
4147+
description: The ID of the machine to rotate the secret key for
4148+
required: true
4149+
schema:
4150+
type: string
4151+
requestBody:
4152+
required: true
4153+
content:
4154+
application/json:
4155+
schema:
4156+
type: object
4157+
required:
4158+
- previous_token_ttl
4159+
properties:
4160+
previous_token_ttl:
4161+
type: integer
4162+
minimum: 0
4163+
maximum: 28800
4164+
description: |-
4165+
The time in seconds that the previous secret key will remain valid after rotation.
4166+
This ensures a graceful transition period for updating applications with the new secret key.
4167+
Set to 0 to immediately expire the previous key. Maximum value is 8 hours (28800 seconds).
4168+
responses:
4169+
'200':
4170+
$ref: '#/components/responses/Machine.SecretKey'
4171+
'400':
4172+
$ref: '#/components/responses/ClerkErrors'
4173+
'401':
4174+
$ref: '#/components/responses/AuthenticationInvalid'
4175+
'403':
4176+
$ref: '#/components/responses/AuthorizationInvalid'
4177+
'404':
4178+
$ref: '#/components/responses/ResourceNotFound'
4179+
'422':
4180+
$ref: '#/components/responses/UnprocessableEntity'
41324181
/machines/{machine_id}/scopes:
41334182
post:
41344183
operationId: CreateMachineScope

‎bapi/2025-04-10.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4120,6 +4120,55 @@ paths:
41204120
$ref: '#/components/responses/AuthorizationInvalid'
41214121
'404':
41224122
$ref: '#/components/responses/ResourceNotFound'
4123+
/machines/{machine_id}/secret_key/rotate:
4124+
post:
4125+
operationId: RotateMachineSecretKey
4126+
x-speakeasy-group: machines
4127+
x-speakeasy-name-override: rotateSecretKey
4128+
summary: Rotate a machine's secret key
4129+
description: |-
4130+
Rotates the machine's secret key.
4131+
When the secret key is rotated, make sure to update it in your machine/application.
4132+
The previous secret key will remain valid for the duration specified by the previous_token_ttl parameter.
4133+
tags:
4134+
- Machines
4135+
parameters:
4136+
- name: machine_id
4137+
in: path
4138+
description: The ID of the machine to rotate the secret key for
4139+
required: true
4140+
schema:
4141+
type: string
4142+
requestBody:
4143+
required: true
4144+
content:
4145+
application/json:
4146+
schema:
4147+
type: object
4148+
required:
4149+
- previous_token_ttl
4150+
properties:
4151+
previous_token_ttl:
4152+
type: integer
4153+
minimum: 0
4154+
maximum: 28800
4155+
description: |-
4156+
The time in seconds that the previous secret key will remain valid after rotation.
4157+
This ensures a graceful transition period for updating applications with the new secret key.
4158+
Set to 0 to immediately expire the previous key. Maximum value is 8 hours (28800 seconds).
4159+
responses:
4160+
'200':
4161+
$ref: '#/components/responses/Machine.SecretKey'
4162+
'400':
4163+
$ref: '#/components/responses/ClerkErrors'
4164+
'401':
4165+
$ref: '#/components/responses/AuthenticationInvalid'
4166+
'403':
4167+
$ref: '#/components/responses/AuthorizationInvalid'
4168+
'404':
4169+
$ref: '#/components/responses/ResourceNotFound'
4170+
'422':
4171+
$ref: '#/components/responses/UnprocessableEntity'
41234172
/machines/{machine_id}/scopes:
41244173
post:
41254174
operationId: CreateMachineScope

0 commit comments

Comments
 (0)