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
46 lines
1.6 KiB
YAML
46 lines
1.6 KiB
YAML
get:
|
|
operationId: getNonEmployeeRequestSummary
|
|
security:
|
|
- UserContextAuth: [idn:nelm:read]
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get Summary of Non-Employee Requests
|
|
description: >-
|
|
This request will retrieve a summary of non-employee requests. There are two
|
|
contextual uses for the `requested-for` path parameter: 1. The current user
|
|
is the Org Admin, in which case he or she may request a summary of all
|
|
non-employee approval requests assigned to a particular account manager by
|
|
passing in that manager's id. 2. The current user is an account manager, in
|
|
which case "me" should be provided as the `requested-for` value. This will
|
|
provide the user with a summary of the non-employee requests in the
|
|
source(s) he or she manages.
|
|
parameters:
|
|
- in: path
|
|
example: "ac10d20a-841e-1e7d-8184-32d2e22c0179"
|
|
name: requested-for
|
|
description: >-
|
|
The identity (UUID) of the non-employee account manager for whom the
|
|
summary is being retrieved. Use "me" instead to indicate the current
|
|
user.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
format: uuid (if user is Org Admin)
|
|
responses:
|
|
"200":
|
|
description: Non-Employee request summary object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../schemas/NonEmployeeRequestSummary.yaml"
|
|
"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"
|