mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-06 12:27:48 +00:00
Remove newly created internal directory
This commit is contained in:
tyler-mairose-sp
@@ -1,18 +0,0 @@
|
||||
in: query
|
||||
name: count
|
||||
description: >-
|
||||
If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned
|
||||
if *limit* and *offset* were ignored.
|
||||
|
||||
|
||||
Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if
|
||||
that value will not be used.
|
||||
|
||||
|
||||
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)
|
||||
for more information.
|
||||
required: false
|
||||
example: true
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
@@ -1,15 +0,0 @@
|
||||
in: query
|
||||
name: limit
|
||||
description: >-
|
||||
Max number of results to return.
|
||||
|
||||
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)
|
||||
for more information.
|
||||
required: false
|
||||
example: 250
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
maximum: 250
|
||||
default: 250
|
||||
@@ -1,15 +0,0 @@
|
||||
in: query
|
||||
name: limit
|
||||
description: >-
|
||||
Note that for this API the maximum value for limit is 50.
|
||||
|
||||
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)
|
||||
for more information.
|
||||
required: false
|
||||
example: 50
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
maximum: 50
|
||||
default: 50
|
||||
@@ -1,14 +0,0 @@
|
||||
in: query
|
||||
name: offset
|
||||
description: >-
|
||||
Offset into the full result set. Usually specified with *limit* to paginate through the results.
|
||||
|
||||
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)
|
||||
for more information.
|
||||
required: false
|
||||
example: 0
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
default: 0
|
||||
@@ -1,7 +0,0 @@
|
||||
in: path
|
||||
name: id
|
||||
description: ID of the requested document.
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
example: 2c91808568c529c60168cca6f90c1313
|
||||
@@ -1,10 +0,0 @@
|
||||
in: path
|
||||
name: index
|
||||
description: |
|
||||
The index from which to fetch the specified document.
|
||||
|
||||
The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
example: accounts
|
||||
@@ -1,34 +0,0 @@
|
||||
post:
|
||||
tags:
|
||||
- Batch Account 90 Days Usage
|
||||
summary: 90 days usage for accountIDs
|
||||
description: >-
|
||||
This API returns a account usage for the past 90 days for the requested batch of IDN account IDs
|
||||
operationId: showBatchAccount90Days
|
||||
security:
|
||||
- UserContextAuth: [ idn:activity-insights:read ]
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/BatchAccount90DaysUsageRequest.yaml'
|
||||
responses:
|
||||
'200':
|
||||
description: Summary of account usage insights for the requested account IDs for the past 90 days.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../schemas/BatchAccount90DaysUsageResponse.yaml'
|
||||
'400':
|
||||
$ref: '../responses/400.yaml'
|
||||
'401':
|
||||
$ref: '../responses/401.yaml'
|
||||
'403':
|
||||
$ref: '../responses/403.yaml'
|
||||
'429':
|
||||
$ref: '../responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../responses/500.yaml'
|
||||
@@ -1,5 +0,0 @@
|
||||
description: Accepted - Returned if the request was successfully accepted into the system.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type : object
|
||||
@@ -1 +0,0 @@
|
||||
description: No content - indicates the request was successful but there is no content to be returned in the response.
|
||||
@@ -1,5 +0,0 @@
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../internal/schemas/ErrorResponseDto.yaml'
|
||||
@@ -1,10 +0,0 @@
|
||||
description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
description: A message describing the error
|
||||
example: "JWT validation failed: JWT is expired"
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../internal/schemas/ErrorResponseDto.yaml'
|
||||
examples:
|
||||
"403":
|
||||
summary: An example of a 403 response object
|
||||
value:
|
||||
detailCode: "403 Forbidden"
|
||||
trackingId: "b21b1f7ce4da4d639f2c62a57171b427"
|
||||
messages:
|
||||
- locale: "en-US"
|
||||
localeOrigin: "DEFAULT"
|
||||
text: "The server understood the request but refuses to authorize it."
|
||||
@@ -1,16 +0,0 @@
|
||||
description: Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../internal/schemas/ErrorResponseDto.yaml'
|
||||
examples:
|
||||
"404":
|
||||
summary: An example of a 404 response object
|
||||
value:
|
||||
detailCode: "404 Not found"
|
||||
trackingId: "b21b1f7ce4da4d639f2c62a57171b427"
|
||||
messages:
|
||||
- locale: "en-US"
|
||||
localeOrigin: "DEFAULT"
|
||||
text: "The server did not find a current representation for the target resource."
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
description: Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
errorName:
|
||||
description: A message describing the error
|
||||
example: "NotSupportedException"
|
||||
errorMessage:
|
||||
description: Description of the error
|
||||
example: Cannot consume content type
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
@@ -1,9 +0,0 @@
|
||||
description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
description: A message describing the error
|
||||
example: " Rate Limit Exceeded "
|
||||
@@ -1,15 +0,0 @@
|
||||
description: Internal Server Error - Returned if there is an unexpected error.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../internal/schemas/ErrorResponseDto.yaml'
|
||||
examples:
|
||||
"500":
|
||||
summary: An example of a 500 response object
|
||||
value:
|
||||
detailCode: "500.0 Internal Fault"
|
||||
trackingId: "b21b1f7ce4da4d639f2c62a57171b427"
|
||||
messages:
|
||||
- locale: "en-US"
|
||||
localeOrigin: "DEFAULT"
|
||||
text: "An internal fault occurred."
|
||||
@@ -1,13 +0,0 @@
|
||||
type: object
|
||||
description: Batch Account 90 Day Usage Request
|
||||
properties:
|
||||
accountIds:
|
||||
type: array
|
||||
description: the batch of IDN account IDs for which we want 90 day usage data, max 250 per request
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
The accountID assigned by IDN to a specific user and source combination. Globally unique across all users/sources within IDN.
|
||||
example: '77212b6a6bf54b3a98bb5f2616665fe3'
|
||||
required:
|
||||
- accountIds
|
||||
@@ -1,27 +0,0 @@
|
||||
type: object
|
||||
description: Batch Account 90 Day Usage Response
|
||||
properties:
|
||||
accountId:
|
||||
type: string
|
||||
description:
|
||||
The accountID assigned by IDN to a specific user and source combination. Globally unique across all users/sources within IDN.
|
||||
example: '77212b6a6bf54b3a98bb5f2616665fe3'
|
||||
usageDays:
|
||||
type: integer
|
||||
format: int64
|
||||
description: >-
|
||||
The number of days within the past 90 days that the user was a active in a source (as represented by the requested IDN accountID).
|
||||
This value must be ignored if `usageDaysState != COMPLETE`.
|
||||
example: 10
|
||||
usageDaysState:
|
||||
type: string
|
||||
description: >-
|
||||
Source Usage Status. Possible values are:
|
||||
- COMPLETE
|
||||
- This status means that an activity data source has been setup and usage insights are available for the source.
|
||||
- UNKNOWN
|
||||
- This status means that an activity data source has not been setup and usage insights are not available for the source.
|
||||
example: COMPLETE
|
||||
enum:
|
||||
- COMPLETE
|
||||
- UNKNOWN
|
||||
@@ -1,14 +0,0 @@
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: The locale for the message text, a BCP 47 language tag.
|
||||
example: en-US
|
||||
localeOrigin:
|
||||
$ref: "../../internal/schemas/LocaleOrigin.yaml"
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example:
|
||||
The request was syntactically correct but its content is semantically
|
||||
invalid.
|
||||
@@ -1,20 +0,0 @@
|
||||
type : object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
$ref: "../../internal/schemas/ErrorMessageDto.yaml"
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
$ref: "../../internal/schemas/ErrorMessageDto.yaml"
|
||||
@@ -1,9 +0,0 @@
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
description: >-
|
||||
An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the
|
||||
locale was selected from the request context (i.e., best match based on the *Accept-Language* header).
|
||||
Additional values may be added in the future without notice.
|
||||
example: DEFAULT
|
||||
@@ -1,63 +0,0 @@
|
||||
type: oauth2
|
||||
description: >-
|
||||
OAuth2 Bearer token (JWT). See
|
||||
[Best Practices: IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication)
|
||||
flows:
|
||||
authorizationCode:
|
||||
authorizationUrl: 'https://tenant.identitynow.com/oauth/authorize'
|
||||
tokenUrl: 'https://tenant.identitynow.com/oauth/token'
|
||||
scopes:
|
||||
'idn:task-definition:read': Task Definition read access
|
||||
'idn:task-definition:write': Task Definition write access
|
||||
'idn:task-management:read': Task Management read access (TaskStatus)
|
||||
'idn:task-management:write': Task Management write access (TaskInvocation)
|
||||
'idn:service-desk-integration:read': Service Desk integration read access
|
||||
'idn:service-desk-integration:write': Service Desk integration write access
|
||||
'idn:service-desk-admin:read': Service Desk admin read access
|
||||
'idn:service-desk-admin:write': Service Desk admin write access
|
||||
'idn:managed-cluster:read': ManagedCluster read access
|
||||
'idn:managed-cluster-log-config:read': ManagedCluster log configuration read access
|
||||
'idn:managed-cluster-log-config:write': ManagedCluster log configuration write access
|
||||
'idn:managed-cluster:upgrade': ManagedCluster client version upgrade access
|
||||
idn:managed-cluster-jobs:read: ManagedCluster read cache for jobs
|
||||
'idn:managed-cluster-types:create': ManagedClusterType create access
|
||||
'idn:managed-cluster-types:read': ManagedClusterType read access
|
||||
'idn:managed-cluster-types:update': ManagedClusterType update access
|
||||
'idn:managed-cluster-types:delete': ManagedClusterType delete access
|
||||
'idn:managed-process:create': ManagedProcess create access
|
||||
'idn:managed-process:read': ManagedProcess read access
|
||||
'idn:managed-process:update': ManagedProcess update access
|
||||
'idn:managed-process:delete': ManagedProcess delete access
|
||||
'idn:nesr:create': Ability to create non-employee records
|
||||
'idn:nesr:delete': Ability to delete non-employee records
|
||||
'idn:nesr:read': Ability to read non-employee records
|
||||
'idn:nesr:update': Ability to update non-employee records
|
||||
idn:provisioning-policy-list:read: Rights to read list of provisioning policies
|
||||
idn:provisioning-policy:read: Right to read provisioning policy
|
||||
idn:provisioning-policy:create: Right to create provisioning policy
|
||||
idn:provisioning-policy:update: Right to update provisioning policy
|
||||
idn:provisioning-policy-bulk:update: Right to update a list of provisioning policies
|
||||
idn:provisioning-policy:delete: Right to delete provisioning policy
|
||||
idn:account:read: Right to read single account
|
||||
idn:account-list:read: Right to read list of accounts
|
||||
idn:account-entitlement:read: Right to read account entitlements
|
||||
idn:account:create: Right to create account
|
||||
idn:account:update: Right to update account
|
||||
idn:account:delete: Right to delete account
|
||||
idn:account:reload: Right to reload account
|
||||
idn:account:enable: Right to enable account
|
||||
idn:account:disable: Right to disable account
|
||||
idn:account:unlock: Right to unlock account
|
||||
'idn:s3-proxy:read': Right to read S3 artifacts
|
||||
'idn:transforms-list:read': Right to access list of transforms
|
||||
'idn:transforms:read': Right to access transforms by id
|
||||
'idn:transforms:write': Right to create and update transforms
|
||||
'idn:transforms:delete': Right to delete transforms
|
||||
'idn:transforms:usage': Right to check whether a transform is referenced elsewhere
|
||||
idn:source-connector:write: Right to configure source-connectors
|
||||
mlops:feature-data:read: Right to retrieve data from the feature store
|
||||
mlops:feature-data:write: Right to update data in the feature store
|
||||
idn:entitlement:read: Right to read entitlements
|
||||
idn:entitlement:update: Right to update entitlements
|
||||
idn:entitlement:create: Right to create entitlements
|
||||
idn:entitlement:delete: Right to delete entitlements
|
||||
@@ -1,23 +0,0 @@
|
||||
openapi: 3.0.1
|
||||
info:
|
||||
title: SailPoint SaaS API
|
||||
version: 3.1.0-internal
|
||||
description: >-
|
||||
See authentication for these APIs here:
|
||||
https://developer.sailpoint.com/idn/api/authentication
|
||||
tags:
|
||||
- name: Batch Account 90 Days Usage
|
||||
description: |
|
||||
Internal endpoint for requesting 90 day usages data for a batch of IDN account IDs
|
||||
components:
|
||||
securitySchemes:
|
||||
http:
|
||||
type: http
|
||||
scheme: bearer
|
||||
bearerFormat: JWT
|
||||
bearerAuth:
|
||||
$ref: "./beta/securitySchemes/OAuth2.yaml"
|
||||
|
||||
paths:
|
||||
/batch-account-90-days-usage:
|
||||
$ref: "./internal/paths/batch-account-90-days-usage.yaml"
|
||||
Reference in New Issue
Block a user