List vendor connector mappings

GET 
/vendor-connector-mappings

Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.

Request

Responses

200

Successfully retrieved list.

application/json

Schema

Schema

• Array [
id string

The unique identifier for the vendor-connector mapping.

vendor string

The name of the vendor.

connector string

The name of the connector.

createdAt date-time

The creation timestamp of the mapping.

createdBy string

The identifier of the user who created the mapping.

updatedAt objectnullable

An object representing the nullable timestamp of the last update.

Time date-time

The timestamp when the mapping was last updated, represented in ISO 8601 format.

Valid boolean

Default value: false

A flag indicating if the 'Time' field is set and valid.

updatedBy objectnullable

An object representing the nullable identifier of the user who last updated the mapping.

String string

The identifier of the user who last updated the mapping, if available.

Valid boolean

Default value: false

A flag indicating if the 'String' field is set and valid.

deletedAt objectnullable

An object representing the nullable timestamp of when the mapping was deleted.

Time date-time

The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable.

Valid boolean

Default value: false

A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted.

deletedBy objectnullable

An object representing the nullable identifier of the user who deleted the mapping.

String string

The identifier of the user who deleted the mapping, if applicable.

Valid boolean

Default value: false

A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted.

• ]

Example (from schema)

[
  {
    "id": "78733556-9ea3-4f59-bf69-e5cd92b011b4",
    "vendor": "Example Vendor",
    "connector": "Example Connector",
    "createdAt": "2024-03-13T12:56:19.391294Z",
    "createdBy": "admin",
    "updatedAt": {
      "Time": "2024-03-14T12:56:19.391294Z",
      "Valid": true
    },
    "updatedBy": {
      "String": "user-67891",
      "Valid": true
    },
    "deletedAt": {
      "Time": "0001-01-01T00:00:00Z",
      "Valid": false
    },
    "deletedBy": {
      "String": "",
      "Valid": false
    }
  },
  {
    "id": "78733556-9ea3-4f59-bf69-e5cd92b011b5",
    "vendor": "Another Corporation",
    "connector": "Another Connector",
    "createdAt": "2024-04-13T11:46:19.391294Z",
    "createdBy": "admin",
    "updatedAt": {
      "Time": "0001-01-01T00:00:00Z",
      "Valid": false
    },
    "updatedBy": {
      "String": "",
      "Valid": false
    },
    "deletedAt": {
      "Time": "0001-01-01T00:00:00Z",
      "Valid": false
    },
    "deletedBy": {
      "String": "",
      "Valid": false
    }
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
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.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
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.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
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.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
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.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

405

Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.

application/json

Schema

Schema

errorName

A message describing the error

errorMessage

Description of the error

trackingId string

Unique tracking id for the error.

Example (from schema)

{
  "errorName": "NotSupportedException",
  "errorMessage": "Cannot consume content type",
  "trackingId": "e7eab60924f64aa284175b9fa3309599"
}

429

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.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
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.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
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.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...