diff --git a/static/api-specs/idn/v3/paths/account-activities.yaml b/static/api-specs/idn/v3/paths/account-activities.yaml index 5ded5cce6..fab383de8 100644 --- a/static/api-specs/idn/v3/paths/account-activities.yaml +++ b/static/api-specs/idn/v3/paths/account-activities.yaml @@ -35,16 +35,9 @@ get: with *requested-for* and *requested-by*. required: false example: 2c91808568c529c60168cca6f90c1313 - - in: query - name: type - schema: - type: string - description: The type of account activity. - required: false - example: Identity Refresh - - $ref: "../../parameters/v3/limit.yaml" - - $ref: "../../parameters/v3/offset.yaml" - - $ref: "../../parameters/v3/count.yaml" + - $ref: "../../v3/parameters/limit.yaml" + - $ref: "../../v3/parameters/offset.yaml" + - $ref: "../../v3/parameters/count.yaml" - in: query name: filters schema: @@ -52,13 +45,13 @@ get: description: >- Filter results using the standard syntax described in [V3 API Standard Collection - Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results). Filtering is supported for the following fields and operators: - **type**: *eq, in* + **type**: *eq, in* (See the `type` property in the response schema for possible values) **created**: *gt, lt, ge, le* @@ -90,14 +83,14 @@ get: schema: type: array items: - $ref: "../../schemas/v3/AccountActivity.yaml" + $ref: "../../v3/schemas/AccountActivity.yaml" "400": - $ref: "../../responses/v3/400.yaml" + $ref: "../../v3/responses/400.yaml" "401": - $ref: "../../responses/v3/401.yaml" + $ref: "../../v3/responses/401.yaml" "403": - $ref: "../../responses/v3/403.yaml" + $ref: "../../v3/responses/403.yaml" "429": - $ref: "../../responses/v3/429.yaml" + $ref: "../../v3/responses/429.yaml" "500": - $ref: "../../responses/v3/500.yaml" + $ref: "../../v3/responses/500.yaml" diff --git a/static/api-specs/idn/v3/paths/account-activity-list.yaml b/static/api-specs/idn/v3/paths/account-activity-list.yaml index 911609189..2643b92f9 100644 --- a/static/api-specs/idn/v3/paths/account-activity-list.yaml +++ b/static/api-specs/idn/v3/paths/account-activity-list.yaml @@ -2,7 +2,7 @@ get: operationId: listAccountActivities tags: - Account Activities - summary: Get a list of Account Activities + summary: List Account Activities description: >- This gets a collection of account activities that satisfy the given query parameters. @@ -35,13 +35,6 @@ get: with *requested-for* and *requested-by*. required: false example: 2c91808568c529c60168cca6f90c1313 - - in: query - name: type - schema: - type: string - description: The type of account activity. - required: false - example: Identity Refresh - $ref: "../parameters/limit.yaml" - $ref: "../parameters/offset.yaml" - $ref: "../parameters/count.yaml" @@ -52,14 +45,18 @@ get: description: >- Filter results using the standard syntax described in [V3 API Standard Collection - Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results). + Filtering is supported for the following fields and operators: - **type**: *eq, in* + + **type**: *eq, in* (See the `type` property in the response schema for possible values) + **created**: *gt, lt, ge, le* + **modified**: *gt, lt, ge, le* example: type eq "Identity Refresh" required: false diff --git a/static/api-specs/idn/v3/schemas/AccountActivity.yaml b/static/api-specs/idn/v3/schemas/AccountActivity.yaml index 429f016d8..d434c18ec 100644 --- a/static/api-specs/idn/v3/schemas/AccountActivity.yaml +++ b/static/api-specs/idn/v3/schemas/AccountActivity.yaml @@ -2,20 +2,25 @@ type: object properties: id: type: string - description: Id of the account activity itself + description: Id of the account activity example: 2c9180835d2e5168015d32f890ca1581 name: type: string + description: The name of the activity example: 2c9180835d2e5168015d32f890ca1581 created: + description: When the activity was first created type: string format: "date-time" example: "2017-07-11T18:45:37.098Z" modified: + description: When the activity was last modified type: string format: "date-time" example: "2018-06-25T20:22:28.104Z" + nullable: true completed: + description: When the activity was completed type: string format: "date-time" nullable: true @@ -23,14 +28,33 @@ properties: completionStatus: $ref: "./CompletionStatus.yaml" type: - type: string + nullable: true + type: string example: appRequest + description: | + The type of action the activity performed. Please see the following list of types. This list may grow over time. + + - CloudAutomated + - IdentityAttributeUpdate + - appRequest + - LifecycleStateChange + - AccountStateUpdate + - AccountAttributeUpdate + - CloudPasswordRequest + - Attribute Synchronization Refresh + - Certification + - Identity Refresh + - Lifecycle Change Refresh + + + [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). requesterIdentitySummary: $ref: "./IdentitySummary.yaml" targetIdentitySummary: $ref: "./IdentitySummary.yaml" errors: nullable: true + description: A list of error messages, if any, that were encountered. type: array items: type: string @@ -42,12 +66,14 @@ properties: ] warnings: nullable: true + description: A list of warning messages, if any, that were encountered. type: array items: type: string example: ["Some warning, another warning"] items: type: array + description: Individual actions performed as part of this account activity items: $ref: "./AccountActivityItem.yaml" executionStatus: diff --git a/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml b/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml index 3e41ecf71..cdd88f437 100644 --- a/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml +++ b/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml @@ -14,6 +14,7 @@ properties: description: Date and time item was requested example: "2017-07-11T18:45:37.098Z" approvalStatus: + nullable: true $ref: "./WorkItemState.yaml" provisioningStatus: $ref: "./ProvisioningState.yaml" @@ -24,6 +25,7 @@ properties: reviewerComment: $ref: "./Comment.yaml" operation: + nullable: true $ref: "./AccountActivityItemOperation.yaml" attribute: type: string diff --git a/static/api-specs/idn/v3/schemas/CompletionStatus.yaml b/static/api-specs/idn/v3/schemas/CompletionStatus.yaml index cbb5f61b8..4452a5baf 100644 --- a/static/api-specs/idn/v3/schemas/CompletionStatus.yaml +++ b/static/api-specs/idn/v3/schemas/CompletionStatus.yaml @@ -1,5 +1,6 @@ nullable: true type: string +description: The status after completion. enum: - SUCCESS - FAILURE diff --git a/static/api-specs/idn/v3/schemas/ExecutionStatus.yaml b/static/api-specs/idn/v3/schemas/ExecutionStatus.yaml index d6f787155..5ae9fb1f1 100644 --- a/static/api-specs/idn/v3/schemas/ExecutionStatus.yaml +++ b/static/api-specs/idn/v3/schemas/ExecutionStatus.yaml @@ -1,4 +1,5 @@ type: string +description: The current state of execution. enum: - EXECUTING - VERIFYING diff --git a/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml b/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml index 0b2be11f5..d21a1c1f3 100644 --- a/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml +++ b/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml @@ -2,6 +2,7 @@ type: string enum: - ACCESS_PROFILE - ROLE + - ENTITLEMENT description: >- Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.