mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
45 lines
1.1 KiB
YAML
45 lines
1.1 KiB
YAML
post:
|
|
operationId: disableAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Disable Account
|
|
description: >-
|
|
This API submits a task to disable the account and returns the task ID.
|
|
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- UserContextAuth: [idn:accounts-state:manage]
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The account id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/AccountToggleRequest.yaml'
|
|
responses:
|
|
'202':
|
|
description: Async task details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/AccountsAsyncResult.yaml'
|
|
'400':
|
|
$ref: '../responses/400.yaml'
|
|
'401':
|
|
$ref: '../responses/401.yaml'
|
|
'403':
|
|
$ref: '../responses/403.yaml'
|
|
'404':
|
|
$ref: '../responses/404.yaml'
|
|
'429':
|
|
$ref: '../responses/429.yaml'
|
|
'500':
|
|
$ref: '../responses/500.yaml'
|