Skip to content

refactor: impersonation API contracts to use userId instead of username #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
prakashchoudhary07 merged 4 commits into from
Jul 3, 2025
Merged

refactor: impersonation API contracts to use userId instead of username #246

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c6615ca
fixed api contract due to updated requirments
Suvidh-kaushik Jul 1, 2025
c852f47
removed createdBy and createdFor from contract
Suvidh-kaushik Jul 1, 2025
3ff2e80
fixed gammatical mistakes
Suvidh-kaushik Jul 1, 2025
da8c8fe
renamed userId and impersonatedUserId to createdBy and createdFor
Suvidh-kaushik Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 9 additions & 17 deletions impersonation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ Creates a new impersonation request.

- Body Parameters:

- `impersonatedUserId`: Required string to specify userId of the user to be impersonated.
- `createdFor`: Required string to specify userId of the user to be impersonated.
- `reason`: Required string to specify reason for requesting impersonation.

- Example Request Body:

```json
{
"impersonatedUserId": "<id of user to impersonate>",
"createdFor": "<id of user to impersonate>",
"reason": "<reason for impersonation>"
}
```
Expand All @@ -59,11 +59,9 @@ Creates a new impersonation request.
"createdAt": "Timestamp",
"updatedAt": "Timestamp",
"status": "string",
"userId": "string",
"impersonatedUserId": "string",
"isImpersonationFinished": "boolean",
"createdBy": "string",
"createdFor": "string",
"isImpersonationFinished": "boolean",
"reason": "string"
}
}
Expand Down Expand Up @@ -120,8 +118,8 @@ Returns a list of impersonation requests with pagination and filtering options.

- `dev`: Required boolean to fetch requests.
- `size`: Optional integer to specify the number of requests per page. Default is 5.
- `createdBy`: Optional string to filter requests by username of super-user who created the request.
- `createdFor`: Optional string to filter requests by username of user for whom the request is created.
- `createdBy`: Optional string to filter requests by the user ID of the super-user who created the request.
- `createdFor`: Optional string to filter requests by the user ID of the user for whom the request is created.
- `status`: Optional string to filter requests by status (e.g., APPROVED, REJECTED, PENDING).

- `prev`: Optional string containing the pagination cursor for the previous page of results.
Expand Down Expand Up @@ -150,11 +148,9 @@ Returns a list of impersonation requests with pagination and filtering options.
"createdAt": "Timestamp",
"updatedAt": "Timestamp",
"status": "string",
"userId": "string",
"impersonatedUserId": "string",
"isImpersonationFinished": "boolean",
"createdBy": "string",
"createdFor": "string",
"isImpersonationFinished": "boolean",
"startedAt": "Timestamp",
"endedAt": "Timestamp",
"reason": "string",
Expand All @@ -165,11 +161,9 @@ Returns a list of impersonation requests with pagination and filtering options.
"createdAt": "Timestamp",
"updatedAt": "Timestamp",
"status": "string",
"userId": "string",
"impersonatedUserId": "string",
"isImpersonationFinished": "boolean",
"createdBy": "string",
"createdFor": "string",
"isImpersonationFinished": "boolean",
"startedAt": "Timestamp",
"endedAt": "Timestamp",
"reason": "string",
Expand Down Expand Up @@ -200,7 +194,7 @@ Returns a list of impersonation requests with pagination and filtering options.
#### Additional Notes


- The provided response includes details of each request, such as its id, createdAt, updatedAt, startedAt, endedAt, createdBy, createdFor, reason, status, userId, impersonatedUserId, isImpersonationFinished and message.
- The provided response includes details of each request, such as its id, createdAt, updatedAt, startedAt, endedAt, reason, status, createdBy, createdFor, isImpersonationFinished and message.

- Pagination functionality is implemented using `next` and `prev` parameters in the response.
- Filtering options are available using parameters like `createdBy`, `createdFor`, `status`, `size`.
Expand Down Expand Up @@ -246,11 +240,9 @@ Returns a single impersonation request identified by its `id`.
"createdAt": "Timestamp",
"updatedAt": "Timestamp",
"status": "string",
"userId": "string",
"impersonatedUserId": "string",
"isImpersonationFinished": "boolean",
"createdBy": "string",
"createdFor": "string",
"isImpersonationFinished": "boolean",
"startedAt": "Timestamp",
"endedAt": "Timestamp",
"reason": "string",
Expand Down