diff --git a/static/api-specs/idn/beta/paths/accounts.yaml b/static/api-specs/idn/beta/paths/accounts.yaml index df2dc719d..52701356d 100644 --- a/static/api-specs/idn/beta/paths/accounts.yaml +++ b/static/api-specs/idn/beta/paths/accounts.yaml @@ -50,6 +50,18 @@ get: **uncorrelated**: *eq* + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: id,name + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **id**, **name**, **created**, **modified** responses: '200': description: List of account objects @@ -58,7 +70,7 @@ get: schema: type: array items: - oneOf: + anyOf: - $ref: '../schemas/SlimAccount.yaml' - $ref: '../schemas/FullAccount.yaml' examples: @@ -122,6 +134,8 @@ post: description: >- This API submits an account creation task and returns the task ID. + The `sourceId` where this account will be created must be included in the `attributes` object. + A token with ORG_ADMIN authority is required to call this API. security: - oauth2: [idn:accounts:manage] @@ -130,7 +144,7 @@ post: content: application/json: schema: - $ref: '../schemas/AccountAttributes.yaml' + $ref: "../schemas/AccountAttributesCreate.yaml" responses: '202': description: Async task details diff --git a/static/api-specs/idn/beta/schemas/AccountAttributesCreate.yaml b/static/api-specs/idn/beta/schemas/AccountAttributesCreate.yaml new file mode 100644 index 000000000..73f045c8c --- /dev/null +++ b/static/api-specs/idn/beta/schemas/AccountAttributesCreate.yaml @@ -0,0 +1,23 @@ +type: object +required: + - attributes +properties: + attributes: + description: The schema attribute values for the account + type: object + required: + - sourceId + properties: + sourceId: + type: string + description: Target source to create an account + example: 34bfcbe116c9407464af37acbaf7a4dc + additionalProperties: + type: string + example: + sourceId: 34bfcbe116c9407464af37acbaf7a4dc + city: Austin + displayName: John Doe + userName: jdoe + sAMAccountName: jDoe + mail: john.doe@sailpoint.com diff --git a/static/api-specs/idn/v3/paths/accounts.yaml b/static/api-specs/idn/v3/paths/accounts.yaml index a4f112068..5a0130c95 100644 --- a/static/api-specs/idn/v3/paths/accounts.yaml +++ b/static/api-specs/idn/v3/paths/accounts.yaml @@ -44,6 +44,18 @@ get: **uncorrelated**: *eq* required: false + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: id,name + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **id**, **name**, **created**, **modified** responses: "200": description: List of account objects @@ -71,6 +83,8 @@ post: description: >- This API submits an account creation task and returns the task ID. + The `sourceId` where this account will be created must be included in the `attributes` object. + A token with ORG_ADMIN authority is required to call this API. security: - oauth2: [idn:accounts:manage]