mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-06 12:27:48 +00:00
Apply automatic changes
This commit is contained in:
tyler-mairose-sp
committed by
github-actions[bot]
github-actions[bot]
parent
b8452af077
commit
75d1859e56
@@ -203246,6 +203246,643 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/sources/{id}/load-accounts": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Sources > Aggregation"
|
||||
],
|
||||
"summary": "Account Aggregation",
|
||||
"operationId": "importAccounts",
|
||||
"description": "Starts an account aggregation on the specified source. \nIf the target source is a direct connection, then the request body must be empty.\nIf the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"required": true,
|
||||
"description": "Source Id",
|
||||
"example": "ef38f94347e94562b5bb8424a56397d8"
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"multipart/form-data": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"file": {
|
||||
"type": "string",
|
||||
"format": "binary"
|
||||
},
|
||||
"disableOptimization": {
|
||||
"type": "boolean",
|
||||
"example": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Aggregate Accounts Task",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"success": {
|
||||
"type": "boolean",
|
||||
"description": "The status of the result",
|
||||
"default": "true",
|
||||
"example": "true"
|
||||
},
|
||||
"task": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "System-generated unique ID of the task this taskStatus represents",
|
||||
"type": "string",
|
||||
"example": "ef38f94347e94562b5bb8424a56397d8"
|
||||
},
|
||||
"type": {
|
||||
"description": "Type of task this task represents",
|
||||
"type": "string",
|
||||
"example": "QUARTZ"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the aggregation process",
|
||||
"type": "string",
|
||||
"example": "Cloud Account Aggregation"
|
||||
},
|
||||
"description": {
|
||||
"description": "The description of the task",
|
||||
"type": "string",
|
||||
"example": "Aggregate from the specified application"
|
||||
},
|
||||
"launcher": {
|
||||
"description": "The user who initiated the task",
|
||||
"type": "string",
|
||||
"example": "John Doe"
|
||||
},
|
||||
"created": {
|
||||
"type": "string",
|
||||
"description": "The Task creation date",
|
||||
"format": "date-time",
|
||||
"example": "2020-09-07T42:14:00.364Z"
|
||||
},
|
||||
"launched": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"format": "date-time",
|
||||
"description": "The task start date",
|
||||
"example": "2020-09-07T42:14:00.521Z"
|
||||
},
|
||||
"completed": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"format": "date-time",
|
||||
"description": "The task completion date",
|
||||
"example": "2020-09-07T42:14:01.137Z"
|
||||
},
|
||||
"completionStatus": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"enum": [
|
||||
"SUCCESS",
|
||||
"WARNING",
|
||||
"ERROR",
|
||||
"TERMINATED",
|
||||
"TEMP_ERROR"
|
||||
],
|
||||
"description": "Task completion status.",
|
||||
"example": "Success"
|
||||
},
|
||||
"parentName": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"description": "Name of the parent task if exists.",
|
||||
"example": "Audit Report"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors.",
|
||||
"example": [],
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Type of the message.",
|
||||
"enum": [
|
||||
"INFO",
|
||||
"WARN",
|
||||
"ERROR"
|
||||
],
|
||||
"example": "WARN"
|
||||
},
|
||||
"error": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Flag whether message is an error.",
|
||||
"example": false
|
||||
},
|
||||
"warning": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Flag whether message is a warning.",
|
||||
"example": true
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "Message string identifier.",
|
||||
"example": "This aggregation failed because the currently running aggregation must complete before the next one can start."
|
||||
},
|
||||
"localizedText": {
|
||||
"type": "string",
|
||||
"description": "Message context with the locale based language.",
|
||||
"example": "This aggregation failed because the currently running aggregation must complete before the next one can start."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"progress": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"description": "Current task state.",
|
||||
"example": "Initializing..."
|
||||
},
|
||||
"attributes": {
|
||||
"type": "object",
|
||||
"description": "Extra attributes map(dictionary) for the task.",
|
||||
"properties": {
|
||||
"appId": {
|
||||
"description": "The id of the source",
|
||||
"type": "string",
|
||||
"example": "c31386cb18bb403cbb6df4c86294ff82"
|
||||
},
|
||||
"optimizedAggregation": {
|
||||
"description": "The indicator if the aggregation process was enabled/disabled for the aggregation job",
|
||||
"example": "enabled"
|
||||
}
|
||||
},
|
||||
"additionalProperties": {
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"returns": {
|
||||
"description": "Return values from the task",
|
||||
"type": "object",
|
||||
"example": [
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS",
|
||||
"attributeName": "applications"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_TOTAL",
|
||||
"attributeName": "total"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_OPTIMIZED",
|
||||
"attributeName": "optimizedAggregation"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_IGNORED",
|
||||
"attributeName": "ignored"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_UNCHANGED_ACCOUNTS",
|
||||
"attributeName": "optimized"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_CREATED",
|
||||
"attributeName": "created"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_UPDATED",
|
||||
"attributeName": "updated"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_DELETED",
|
||||
"attributeName": "deleted"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_MANAGER_CHANGES",
|
||||
"attributeName": "managerChanges"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_BUSINESS_ROLE_CHANGES",
|
||||
"attributeName": "detectedRoleChanges"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_EXCEPTION_CHANGES",
|
||||
"attributeName": "exceptionChanges"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_POLICIES",
|
||||
"attributeName": "policies"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_POLICY_VIOLATIONS",
|
||||
"attributeName": "policyViolations"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_POLICY_NOTIFICATIONS",
|
||||
"attributeName": "policyNotifications"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_SCORES_CHANGED",
|
||||
"attributeName": "scoresChanged"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_SNAPSHOTS_CREATED",
|
||||
"attributeName": "snapshotsCreated"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CREATED",
|
||||
"attributeName": "scopesCreated"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CORRELATED",
|
||||
"attributeName": "scopesCorrelated"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_SELECTED",
|
||||
"attributeName": "scopesSelected"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_DORMANT",
|
||||
"attributeName": "scopesDormant"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_UNSCOPED_IDENTITIES",
|
||||
"attributeName": "unscopedIdentities"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_CREATED",
|
||||
"attributeName": "certificationsCreated"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_DELETED",
|
||||
"attributeName": "certificationsDeleted"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS_GENERATED",
|
||||
"attributeName": "applicationsGenerated"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED",
|
||||
"attributeName": "managedAttributesCreated"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP",
|
||||
"attributeName": "managedAttributesCreatedByApplication"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_IDENTITYENTITLEMENTS_CREATED",
|
||||
"attributeName": "identityEntitlementsCreated"
|
||||
},
|
||||
{
|
||||
"displayLabel": "TASK_OUT_ACCOUNT_AGGREGATION_GROUPS_CREATED",
|
||||
"attributeName": "groupsCreated"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Client Error - Returned if the request body is invalid.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"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": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"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",
|
||||
"nullable": true
|
||||
},
|
||||
"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."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"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",
|
||||
"nullable": true
|
||||
},
|
||||
"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."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"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": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"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",
|
||||
"nullable": true
|
||||
},
|
||||
"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."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"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",
|
||||
"nullable": true
|
||||
},
|
||||
"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."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"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 "
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error - Returned if there is an unexpected error.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"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": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"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",
|
||||
"nullable": true
|
||||
},
|
||||
"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."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"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",
|
||||
"nullable": true
|
||||
},
|
||||
"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."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"UserContextAuth": [
|
||||
"idn:account:create"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/task-status/{id}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
|
||||
@@ -152185,6 +152185,448 @@ paths:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: An internal fault occurred.
|
||||
'/sources/{id}/load-accounts':
|
||||
post:
|
||||
tags:
|
||||
- Sources > Aggregation
|
||||
summary: Account Aggregation
|
||||
operationId: importAccounts
|
||||
description: |-
|
||||
Starts an account aggregation on the specified source.
|
||||
If the target source is a direct connection, then the request body must be empty.
|
||||
If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Source Id
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
requestBody:
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
file:
|
||||
type: string
|
||||
format: binary
|
||||
disableOptimization:
|
||||
type: boolean
|
||||
example: 'true'
|
||||
responses:
|
||||
'202':
|
||||
description: Aggregate Accounts Task
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
success:
|
||||
type: boolean
|
||||
description: The status of the result
|
||||
default: 'true'
|
||||
example: 'true'
|
||||
task:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: System-generated unique ID of the task this taskStatus represents
|
||||
type: string
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
type:
|
||||
description: Type of task this task represents
|
||||
type: string
|
||||
example: QUARTZ
|
||||
name:
|
||||
description: The name of the aggregation process
|
||||
type: string
|
||||
example: Cloud Account Aggregation
|
||||
description:
|
||||
description: The description of the task
|
||||
type: string
|
||||
example: Aggregate from the specified application
|
||||
launcher:
|
||||
description: The user who initiated the task
|
||||
type: string
|
||||
example: John Doe
|
||||
created:
|
||||
type: string
|
||||
description: The Task creation date
|
||||
format: date-time
|
||||
example: '2020-09-07T42:14:00.364Z'
|
||||
launched:
|
||||
type: string
|
||||
nullable: true
|
||||
format: date-time
|
||||
description: The task start date
|
||||
example: '2020-09-07T42:14:00.521Z'
|
||||
completed:
|
||||
type: string
|
||||
nullable: true
|
||||
format: date-time
|
||||
description: The task completion date
|
||||
example: '2020-09-07T42:14:01.137Z'
|
||||
completionStatus:
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
- SUCCESS
|
||||
- WARNING
|
||||
- ERROR
|
||||
- TERMINATED
|
||||
- TEMP_ERROR
|
||||
description: Task completion status.
|
||||
example: Success
|
||||
parentName:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Name of the parent task if exists.
|
||||
example: Audit Report
|
||||
messages:
|
||||
type: array
|
||||
description: List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors.
|
||||
example: []
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: Type of the message.
|
||||
enum:
|
||||
- INFO
|
||||
- WARN
|
||||
- ERROR
|
||||
example: WARN
|
||||
error:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Flag whether message is an error.
|
||||
example: false
|
||||
warning:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Flag whether message is a warning.
|
||||
example: true
|
||||
key:
|
||||
type: string
|
||||
description: Message string identifier.
|
||||
example: This aggregation failed because the currently running aggregation must complete before the next one can start.
|
||||
localizedText:
|
||||
type: string
|
||||
description: Message context with the locale based language.
|
||||
example: This aggregation failed because the currently running aggregation must complete before the next one can start.
|
||||
progress:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Current task state.
|
||||
example: Initializing...
|
||||
attributes:
|
||||
type: object
|
||||
description: Extra attributes map(dictionary) for the task.
|
||||
properties:
|
||||
appId:
|
||||
description: The id of the source
|
||||
type: string
|
||||
example: c31386cb18bb403cbb6df4c86294ff82
|
||||
optimizedAggregation:
|
||||
description: The indicator if the aggregation process was enabled/disabled for the aggregation job
|
||||
example: enabled
|
||||
additionalProperties:
|
||||
type: object
|
||||
returns:
|
||||
description: Return values from the task
|
||||
type: object
|
||||
example:
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS
|
||||
attributeName: applications
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_TOTAL
|
||||
attributeName: total
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_OPTIMIZED
|
||||
attributeName: optimizedAggregation
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_IGNORED
|
||||
attributeName: ignored
|
||||
- displayLabel: TASK_OUT_UNCHANGED_ACCOUNTS
|
||||
attributeName: optimized
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_CREATED
|
||||
attributeName: created
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_UPDATED
|
||||
attributeName: updated
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_DELETED
|
||||
attributeName: deleted
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_MANAGER_CHANGES
|
||||
attributeName: managerChanges
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_BUSINESS_ROLE_CHANGES
|
||||
attributeName: detectedRoleChanges
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_EXCEPTION_CHANGES
|
||||
attributeName: exceptionChanges
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_POLICIES
|
||||
attributeName: policies
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_POLICY_VIOLATIONS
|
||||
attributeName: policyViolations
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_POLICY_NOTIFICATIONS
|
||||
attributeName: policyNotifications
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCORES_CHANGED
|
||||
attributeName: scoresChanged
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SNAPSHOTS_CREATED
|
||||
attributeName: snapshotsCreated
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CREATED
|
||||
attributeName: scopesCreated
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CORRELATED
|
||||
attributeName: scopesCorrelated
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_SELECTED
|
||||
attributeName: scopesSelected
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_DORMANT
|
||||
attributeName: scopesDormant
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_UNSCOPED_IDENTITIES
|
||||
attributeName: unscopedIdentities
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_CREATED
|
||||
attributeName: certificationsCreated
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_DELETED
|
||||
attributeName: certificationsDeleted
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS_GENERATED
|
||||
attributeName: applicationsGenerated
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED
|
||||
attributeName: managedAttributesCreated
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP
|
||||
attributeName: managedAttributesCreatedByApplication
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_IDENTITYENTITLEMENTS_CREATED
|
||||
attributeName: identityEntitlementsCreated
|
||||
- displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_GROUPS_CREATED
|
||||
attributeName: groupsCreated
|
||||
'400':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
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:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
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
|
||||
nullable: true
|
||||
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.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
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
|
||||
nullable: true
|
||||
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.
|
||||
'401':
|
||||
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'
|
||||
'403':
|
||||
description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
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:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
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
|
||||
nullable: true
|
||||
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.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
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
|
||||
nullable: true
|
||||
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.
|
||||
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.
|
||||
'429':
|
||||
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 '
|
||||
'500':
|
||||
description: Internal Server Error - Returned if there is an unexpected error.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
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:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
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
|
||||
nullable: true
|
||||
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.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
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
|
||||
nullable: true
|
||||
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.
|
||||
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.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- 'idn:account:create'
|
||||
'/task-status/{id}':
|
||||
get:
|
||||
tags:
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user