LukeParke/api-specs
1
0
Fork 0
mirror of https://github.com/LukeHagar/api-specs.git synced 2025-12-10 12:27:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automated commit 'ARSENAL-21107 Update docs for PATCH /accounts (#1552)' by github action: 8573641220

Browse Source
This commit is contained in:
GitHub Action Bot
2024-04-05 17:38:11 +00:00
parent b745b313a0
commit 4c388edc6d
2 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
idn/beta/paths/account.yaml
View File

@@ -42,11 +42,15 @@ patch:
- Accounts - Accounts
summary: Update Account summary: Update Account
description: >- description: >-
Use this endpoint to update an account with a PATCH request. This updates account details.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
The request must provide a JSONPatch payload. This endpoint supports updating an account's correlation. It can only modify the identityId and manuallyCorrelated
attributes. To re-assign an account from one identity to another, replace the current identityId with a new value.
A token with ORG_ADMIN authority is required to call this API. If the account you're assigning was provisioned by IdentityNow, it's possible IdentityNow could create a new account
for the previous identity as soon as the account is moved. If the account you're assigning is authoritative,
this will cause the previous identity to become uncorrelated and could even result in its deletion. All accounts
that are are reassigned will be set to manuallyCorrelated: true.
security: security:
- UserContextAuth: [idn:accounts:manage] - UserContextAuth: [idn:accounts:manage]
parameters: parameters:
@@ -180,4 +184,4 @@ delete:
"429": "429":
$ref: "../../v3/responses/429.yaml" $ref: "../../v3/responses/429.yaml"
"500": "500":
$ref: "../../v3/responses/500.yaml" $ref: "../../v3/responses/500.yaml"

18
idn/v3/paths/account.yaml
View File

@@ -42,17 +42,15 @@ patch:
- Accounts - Accounts
summary: Update Account summary: Update Account
description: >- description: >-
Use this API to update the account with a PATCH request. This updates account details.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
This endpoint can only modify these fields:
* `identityId` This endpoint supports updating an account's correlation. It can only modify the identityId and manuallyCorrelated
attributes. To re-assign an account from one identity to another, replace the current identityId with a new value.
* `manuallyCorrelated` If the account you're assigning was provisioned by IdentityNow, it's possible IdentityNow could create a new account
for the previous identity as soon as the account is moved. If the account you're assigning is authoritative,
The request must provide a JSONPatch payload. this will cause the previous identity to become uncorrelated and could even result in its deletion. All accounts
that are are reassigned will be set to manuallyCorrelated: true.
A token with ORG_ADMIN authority is required to call this API.
security: security:
- UserContextAuth: [idn:accounts:manage] - UserContextAuth: [idn:accounts:manage]
parameters: parameters: