mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
86 lines
2.9 KiB
YAML
86 lines
2.9 KiB
YAML
post:
|
|
operationId: deleteAccessProfilesInBulk
|
|
summary: Delete Access Profile(s)
|
|
tags:
|
|
- Access Profiles
|
|
description: >-
|
|
This API initiates a bulk deletion of one or more Access Profiles.
|
|
|
|
|
|
By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse**
|
|
field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is
|
|
**true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will
|
|
be deleted.
|
|
|
|
|
|
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition,
|
|
a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able
|
|
to administer.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../../v3/schemas/access/AccessProfileBulkDeleteRequest.yaml'
|
|
example:
|
|
{
|
|
"bestEffortOnly": true,
|
|
"accessProfileIds": [ "2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816" ]
|
|
}
|
|
responses:
|
|
'200':
|
|
description: Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../../v3/schemas/access/AccessProfileBulkDeleteResponse.yaml'
|
|
example:
|
|
{
|
|
"pending": [],
|
|
"inUse": [
|
|
{
|
|
"accessProfileId": "2c91808876438ba801766e129f151816",
|
|
"usages": [
|
|
{
|
|
"type": "Role",
|
|
"id": "2c9180887643764201766e9f6e121518"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
'202':
|
|
description: Returned if at least one deletion will be performed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../../v3/schemas/access/AccessProfileBulkDeleteResponse.yaml'
|
|
example:
|
|
{
|
|
"taskId":"2c91808a7813090a01781412a1119a20",
|
|
"pending":["2c91808a7813090a017813fe1919ecca"],
|
|
"inUse": [
|
|
{
|
|
"accessProfileId": "2c91808876438ba801766e129f151816",
|
|
"usages": [
|
|
{
|
|
"type": "Role",
|
|
"id": "2c9180887643764201766e9f6e121518"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:access-profile:manage]
|