mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
635251752f
* IDNPALM-4257 Access profile bulk update API documentation. * IDNPALM-4257 Access profile bulk update API documentation. * IDNPALM-4257 Lint errors resolved. * IDNPALM-4257 Lint errors resolved. * IDNPALM-4257 feature flag precondition response added. * IDNPALM-4257 API name changed. * IDNPALM-4249 Remove comment configuration options from POST /v3/access-profiles' by github action: 7841109100
62 lines
2.2 KiB
YAML
62 lines
2.2 KiB
YAML
post:
|
|
operationId: updateAccessProfilesInBulk
|
|
summary: Update Access Profile(s) requestable field.
|
|
tags:
|
|
- Access Profiles
|
|
description: >-
|
|
This API initiates a bulk update of field requestable for one or more Access Profiles.
|
|
|
|
|
|
> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated**
|
|
list of the response.Requestable field of these Access Profiles marked as **true** or **false**.
|
|
|
|
> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound**
|
|
list of the response. Access Profiles marked as **notFound** will not be updated.
|
|
|
|
> 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 update Access Profiles which are associated with Sources they are able
|
|
to administer.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../../v3/schemas/access/AccessProfileBulkUpdateRequest.yaml'
|
|
example:
|
|
[
|
|
{
|
|
"id": "464ae7bf-791e-49fd-b746-06a2e4a89635",
|
|
"requestable": false
|
|
}
|
|
]
|
|
responses:
|
|
'207':
|
|
description: List of updated and not updated Access Profiles.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../../v3/schemas/access/AccessProfileBulkUpdateResponse.yaml'
|
|
example:
|
|
[
|
|
{
|
|
"id": "464ae7bf-791e-49fd-b746-06a2e4a89635",
|
|
"status": "201",
|
|
"requestable": false,
|
|
"description": "Access Profile updated successfully."
|
|
}
|
|
]
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'412':
|
|
$ref: '../../v3/responses/412.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:access-profile:manage]
|