sailpoint-api-client 2.0.4 → 2.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +3 -0
- package/dist/index.js +192 -189
- package/dist/index.js.map +1 -1
- package/dist/intelligence/api.d.ts +952 -0
- package/dist/intelligence/api.js +589 -0
- package/dist/intelligence/api.js.map +1 -0
- package/dist/intelligence/base.d.ts +66 -0
- package/dist/intelligence/base.js +90 -0
- package/dist/intelligence/base.js.map +1 -0
- package/dist/intelligence/common.d.ts +65 -0
- package/dist/intelligence/common.js +292 -0
- package/dist/intelligence/common.js.map +1 -0
- package/dist/intelligence/configuration.d.ts +91 -0
- package/dist/intelligence/configuration.js +46 -0
- package/dist/intelligence/configuration.js.map +1 -0
- package/dist/intelligence/index.d.ts +13 -0
- package/dist/intelligence/index.js +32 -0
- package/dist/intelligence/index.js.map +1 -0
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/sources/api.d.ts +509 -1
- package/dist/sources/api.js +587 -4
- package/dist/sources/api.js.map +1 -1
- package/index.ts +3 -0
- package/intelligence/.openapi-generator/FILES +36 -0
- package/intelligence/.openapi-generator/VERSION +1 -0
- package/intelligence/.openapi-generator-ignore +23 -0
- package/intelligence/.sdk-partition +1 -0
- package/intelligence/api.ts +1220 -0
- package/intelligence/base.ts +86 -0
- package/intelligence/common.ts +183 -0
- package/intelligence/configuration.ts +110 -0
- package/intelligence/docs/Examples/typescript_code_examples_overlay.yaml +78 -0
- package/intelligence/docs/Methods/Index.md +30 -0
- package/intelligence/docs/Methods/IntelligenceApi.md +253 -0
- package/intelligence/docs/Models/Errormessagedto.md +21 -0
- package/intelligence/docs/Models/Errorresponsedto.md +22 -0
- package/intelligence/docs/Models/GetIdentityIntelligenceV1401Response.md +19 -0
- package/intelligence/docs/Models/GetIdentityIntelligenceV1429Response.md +19 -0
- package/intelligence/docs/Models/Index.md +19 -0
- package/intelligence/docs/Models/Intelaccessaccountwire.md +30 -0
- package/intelligence/docs/Models/Intelaccesshistory.md +20 -0
- package/intelligence/docs/Models/Intelaccesshistoryaccessitemsslice.md +20 -0
- package/intelligence/docs/Models/Intelaccesshistorycertificationsslice.md +20 -0
- package/intelligence/docs/Models/Intelaccessitemhistoryevent.md +20 -0
- package/intelligence/docs/Models/Intelaccesssourcewire.md +20 -0
- package/intelligence/docs/Models/Intelaccountsslice.md +20 -0
- package/intelligence/docs/Models/Intelcertificationhistoryevent.md +23 -0
- package/intelligence/docs/Models/Intelidentityaggregate.md +35 -0
- package/intelligence/docs/Models/Inteloutlieraccessitem.md +24 -0
- package/intelligence/docs/Models/Inteloutliersslice.md +19 -0
- package/intelligence/docs/Models/Intelprivilegedaccessitemwire.md +26 -0
- package/intelligence/docs/Models/IntelprivilegedaccessitemwireSource.md +20 -0
- package/intelligence/docs/Models/Intelprivilegedaccessslice.md +19 -0
- package/intelligence/docs/Models/Intelrareaccessslice.md +20 -0
- package/intelligence/docs/Models/Localeorigin.md +21 -0
- package/intelligence/docs/Models/README.md +46 -0
- package/intelligence/git_push.sh +57 -0
- package/intelligence/index.ts +18 -0
- package/intelligence/package.json +34 -0
- package/intelligence/tsconfig.json +21 -0
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/package.json +1 -1
- package/sources/.openapi-generator/FILES +2 -0
- package/sources/api.ts +846 -9
- package/sources/docs/Examples/typescript_code_examples_overlay.yaml +101 -0
- package/sources/docs/Methods/SourcesApi.md +288 -0
- package/sources/docs/Models/Fielddetailsdtov2.md +24 -0
- package/sources/docs/Models/Provisioningpolicydtov2.md +24 -0
- package/sources/docs/Models/Usagetype.md +2 -0
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelligence
|
|
3
|
+
title: Intelligence
|
|
4
|
+
pagination_label: Intelligence
|
|
5
|
+
sidebar_label: Intelligence
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelligence', 'v1Intelligence']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/methods/intelligence
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelligence', 'v1Intelligence']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# IntelligenceApi
|
|
13
|
+
Read-only HTTP API that returns the Intelligence (identity context)
|
|
14
|
+
for SecOps enrichment use cases (SIEM/SOAR connectors, MCP, browser
|
|
15
|
+
extension). Backed by Atlas internal-REST calls to MICE, Shelby List Accounts,
|
|
16
|
+
SDS Search, IDA-outliers, and identity-history.
|
|
17
|
+
|
|
18
|
+
All URIs are relative to *https://sailpoint.api.identitynow.com*
|
|
19
|
+
|
|
20
|
+
Method | HTTP request | Description
|
|
21
|
+
------------- | ------------- | -------------
|
|
22
|
+
[**get-identity-intelligence-v1**](#get-identity-intelligence-v1) | **GET** `/intelligence/v1/identities` | Get identity by filter
|
|
23
|
+
[**get-intel-identity-access-item-history-v1**](#get-intel-identity-access-item-history-v1) | **GET** `/intelligence/v1/identities/{id}/access-history/access-items` | List identity access item history
|
|
24
|
+
[**get-intel-identity-accounts-v1**](#get-intel-identity-accounts-v1) | **GET** `/intelligence/v1/identities/{id}/accounts` | List identity accounts
|
|
25
|
+
[**get-intel-identity-certification-history-v1**](#get-intel-identity-certification-history-v1) | **GET** `/intelligence/v1/identities/{id}/access-history/certifications` | List identity certification history
|
|
26
|
+
[**get-intel-identity-rare-access-v1**](#get-intel-identity-rare-access-v1) | **GET** `/intelligence/v1/identities/{id}/outliers/rare-access` | List identity rare access
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## get-identity-intelligence-v1
|
|
30
|
+
Get identity by filter
|
|
31
|
+
Requires tenant license idn:response-and-remediation.
|
|
32
|
+
|
|
33
|
+
Resolves exactly one identity by SCIM-style filters expression and returns the Intelligence envelope.
|
|
34
|
+
Supported queryable fields are id and email only.
|
|
35
|
+
The response embeds the first page of accounts, rare access, access-history access items, and
|
|
36
|
+
access-history certifications. Paged slices include a next link only when more results exist.
|
|
37
|
+
The privilegedAccess slice contains the full result and is not paged.
|
|
38
|
+
The outliers slice is omitted when the tenant lacks the IDA-outliers license.
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-identity-intelligence-v-1)
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
Name | Type | Description | Notes
|
|
47
|
+
------------- | ------------- | ------------- | -------------
|
|
48
|
+
**filters** | `string` | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **email**: *eq* | [default to undefined]
|
|
49
|
+
|
|
50
|
+
### Return type
|
|
51
|
+
|
|
52
|
+
`Intelidentityaggregate`
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: Not defined
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
### Example
|
|
60
|
+
|
|
61
|
+
```typescript
|
|
62
|
+
import { IntelligenceApi } from 'sailpoint-api-client';
|
|
63
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
64
|
+
|
|
65
|
+
const configuration = new Configuration();
|
|
66
|
+
const apiInstance = new IntelligenceApi(configuration);
|
|
67
|
+
const filters: string = id eq "ef38f94347e94562b5bb8424a56397d8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **email**: *eq*
|
|
68
|
+
const result = await apiInstance.getIdentityIntelligenceV1({ filters: filters });
|
|
69
|
+
console.log(result);
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
[[Back to top]](#)
|
|
73
|
+
|
|
74
|
+
## get-intel-identity-access-item-history-v1
|
|
75
|
+
List identity access item history
|
|
76
|
+
Continuation endpoint for the parent response's `accessHistory.accessItems.next` link.
|
|
77
|
+
Returns one page of access-item history events for the supplied limit and offset values.
|
|
78
|
+
Unsupported event types and per-record decode failures are dropped server-side.
|
|
79
|
+
Requires tenant license idn:response-and-remediation.
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-intel-identity-access-item-history-v-1)
|
|
83
|
+
|
|
84
|
+
### Parameters
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
Name | Type | Description | Notes
|
|
88
|
+
------------- | ------------- | ------------- | -------------
|
|
89
|
+
**id** | `string` | Non-empty identity id path segment for Intelligence sub-resources. | [default to undefined]
|
|
90
|
+
**limit** | `number` | Page size. Defaults to 250; values above 250 are rejected with 400. | [optional] [default to 250]
|
|
91
|
+
**offset** | `number` | Zero-based page offset. Defaults to 0. | [optional] [default to 0]
|
|
92
|
+
|
|
93
|
+
### Return type
|
|
94
|
+
|
|
95
|
+
`Array<Intelaccessitemhistoryevent>`
|
|
96
|
+
|
|
97
|
+
### HTTP request headers
|
|
98
|
+
|
|
99
|
+
- **Content-Type**: Not defined
|
|
100
|
+
- **Accept**: application/json
|
|
101
|
+
|
|
102
|
+
### Example
|
|
103
|
+
|
|
104
|
+
```typescript
|
|
105
|
+
import { IntelligenceApi } from 'sailpoint-api-client';
|
|
106
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
107
|
+
|
|
108
|
+
const configuration = new Configuration();
|
|
109
|
+
const apiInstance = new IntelligenceApi(configuration);
|
|
110
|
+
const id: string = ef38f94347e94562b5bb8424a56397d8; // Non-empty identity id path segment for Intelligence sub-resources.
|
|
111
|
+
const limit: number = 250; // Page size. Defaults to 250; values above 250 are rejected with 400. (optional)
|
|
112
|
+
const offset: number = 0; // Zero-based page offset. Defaults to 0. (optional)
|
|
113
|
+
const result = await apiInstance.getIntelIdentityAccessItemHistoryV1({ id: id });
|
|
114
|
+
console.log(result);
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
[[Back to top]](#)
|
|
118
|
+
|
|
119
|
+
## get-intel-identity-accounts-v1
|
|
120
|
+
List identity accounts
|
|
121
|
+
Continuation endpoint for the parent response's `accounts.next` link.
|
|
122
|
+
Returns one page of account rows for the supplied limit and offset values.
|
|
123
|
+
Requires tenant license idn:response-and-remediation.
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-intel-identity-accounts-v-1)
|
|
127
|
+
|
|
128
|
+
### Parameters
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
Name | Type | Description | Notes
|
|
132
|
+
------------- | ------------- | ------------- | -------------
|
|
133
|
+
**id** | `string` | Non-empty identity id path segment for Intelligence sub-resources. | [default to undefined]
|
|
134
|
+
**limit** | `number` | Page size. Defaults to 250; values above 250 are rejected with 400. | [optional] [default to 250]
|
|
135
|
+
**offset** | `number` | Zero-based page offset. Defaults to 0. | [optional] [default to 0]
|
|
136
|
+
|
|
137
|
+
### Return type
|
|
138
|
+
|
|
139
|
+
`Array<Intelaccessaccountwire>`
|
|
140
|
+
|
|
141
|
+
### HTTP request headers
|
|
142
|
+
|
|
143
|
+
- **Content-Type**: Not defined
|
|
144
|
+
- **Accept**: application/json
|
|
145
|
+
|
|
146
|
+
### Example
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
import { IntelligenceApi } from 'sailpoint-api-client';
|
|
150
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
151
|
+
|
|
152
|
+
const configuration = new Configuration();
|
|
153
|
+
const apiInstance = new IntelligenceApi(configuration);
|
|
154
|
+
const id: string = ef38f94347e94562b5bb8424a56397d8; // Non-empty identity id path segment for Intelligence sub-resources.
|
|
155
|
+
const limit: number = 250; // Page size. Defaults to 250; values above 250 are rejected with 400. (optional)
|
|
156
|
+
const offset: number = 0; // Zero-based page offset. Defaults to 0. (optional)
|
|
157
|
+
const result = await apiInstance.getIntelIdentityAccountsV1({ id: id });
|
|
158
|
+
console.log(result);
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
[[Back to top]](#)
|
|
162
|
+
|
|
163
|
+
## get-intel-identity-certification-history-v1
|
|
164
|
+
List identity certification history
|
|
165
|
+
Continuation endpoint for the parent response's `accessHistory.certifications.next` link.
|
|
166
|
+
Returns one page of certification history events for the supplied limit and offset values.
|
|
167
|
+
Per-record decode failures are dropped server-side.
|
|
168
|
+
Requires tenant license idn:response-and-remediation.
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-intel-identity-certification-history-v-1)
|
|
172
|
+
|
|
173
|
+
### Parameters
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
Name | Type | Description | Notes
|
|
177
|
+
------------- | ------------- | ------------- | -------------
|
|
178
|
+
**id** | `string` | Non-empty identity id path segment for Intelligence sub-resources. | [default to undefined]
|
|
179
|
+
**limit** | `number` | Page size. Defaults to 250; values above 250 are rejected with 400. | [optional] [default to 250]
|
|
180
|
+
**offset** | `number` | Zero-based page offset. Defaults to 0. | [optional] [default to 0]
|
|
181
|
+
|
|
182
|
+
### Return type
|
|
183
|
+
|
|
184
|
+
`Array<Intelcertificationhistoryevent>`
|
|
185
|
+
|
|
186
|
+
### HTTP request headers
|
|
187
|
+
|
|
188
|
+
- **Content-Type**: Not defined
|
|
189
|
+
- **Accept**: application/json
|
|
190
|
+
|
|
191
|
+
### Example
|
|
192
|
+
|
|
193
|
+
```typescript
|
|
194
|
+
import { IntelligenceApi } from 'sailpoint-api-client';
|
|
195
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
196
|
+
|
|
197
|
+
const configuration = new Configuration();
|
|
198
|
+
const apiInstance = new IntelligenceApi(configuration);
|
|
199
|
+
const id: string = ef38f94347e94562b5bb8424a56397d8; // Non-empty identity id path segment for Intelligence sub-resources.
|
|
200
|
+
const limit: number = 250; // Page size. Defaults to 250; values above 250 are rejected with 400. (optional)
|
|
201
|
+
const offset: number = 0; // Zero-based page offset. Defaults to 0. (optional)
|
|
202
|
+
const result = await apiInstance.getIntelIdentityCertificationHistoryV1({ id: id });
|
|
203
|
+
console.log(result);
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
[[Back to top]](#)
|
|
207
|
+
|
|
208
|
+
## get-intel-identity-rare-access-v1
|
|
209
|
+
List identity rare access
|
|
210
|
+
Continuation endpoint for the parent response's `outliers.rareAccess.next` link.
|
|
211
|
+
Resolves the identity's first outlier, then returns one page of rare access
|
|
212
|
+
items for the supplied limit and offset values. An identity with no outlier
|
|
213
|
+
returns an empty array. Requires tenant license idn:response-and-remediation
|
|
214
|
+
and the IDA-outliers license.
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-intel-identity-rare-access-v-1)
|
|
218
|
+
|
|
219
|
+
### Parameters
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
Name | Type | Description | Notes
|
|
223
|
+
------------- | ------------- | ------------- | -------------
|
|
224
|
+
**id** | `string` | Non-empty identity id path segment for Intelligence sub-resources. | [default to undefined]
|
|
225
|
+
**limit** | `number` | Page size. Defaults to 250; values above 250 are rejected with 400. | [optional] [default to 250]
|
|
226
|
+
**offset** | `number` | Zero-based page offset. Defaults to 0. | [optional] [default to 0]
|
|
227
|
+
|
|
228
|
+
### Return type
|
|
229
|
+
|
|
230
|
+
`Array<Inteloutlieraccessitem>`
|
|
231
|
+
|
|
232
|
+
### HTTP request headers
|
|
233
|
+
|
|
234
|
+
- **Content-Type**: Not defined
|
|
235
|
+
- **Accept**: application/json
|
|
236
|
+
|
|
237
|
+
### Example
|
|
238
|
+
|
|
239
|
+
```typescript
|
|
240
|
+
import { IntelligenceApi } from 'sailpoint-api-client';
|
|
241
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
242
|
+
|
|
243
|
+
const configuration = new Configuration();
|
|
244
|
+
const apiInstance = new IntelligenceApi(configuration);
|
|
245
|
+
const id: string = ef38f94347e94562b5bb8424a56397d8; // Non-empty identity id path segment for Intelligence sub-resources.
|
|
246
|
+
const limit: number = 250; // Page size. Defaults to 250; values above 250 are rejected with 400. (optional)
|
|
247
|
+
const offset: number = 0; // Zero-based page offset. Defaults to 0. (optional)
|
|
248
|
+
const result = await apiInstance.getIntelIdentityRareAccessV1({ id: id });
|
|
249
|
+
console.log(result);
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
[[Back to top]](#)
|
|
253
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-errormessagedto
|
|
3
|
+
title: Errormessagedto
|
|
4
|
+
pagination_label: Errormessagedto
|
|
5
|
+
sidebar_label: Errormessagedto
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Errormessagedto', 'v1Errormessagedto']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/errormessagedto
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Errormessagedto', 'v1Errormessagedto']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Errormessagedto
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**locale** | **(optional)** `string` | The locale for the message text, a BCP 47 language tag. | [default to undefined]
|
|
19
|
+
**localeOrigin** | **(optional)** `Localeorigin` | | [default to undefined]
|
|
20
|
+
**text** | **(optional)** `string` | Actual text of the error message in the indicated locale. | [default to undefined]
|
|
21
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-errorresponsedto
|
|
3
|
+
title: Errorresponsedto
|
|
4
|
+
pagination_label: Errorresponsedto
|
|
5
|
+
sidebar_label: Errorresponsedto
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Errorresponsedto', 'v1Errorresponsedto']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/errorresponsedto
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Errorresponsedto', 'v1Errorresponsedto']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Errorresponsedto
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**detailCode** | **(optional)** `string` | Fine-grained error code providing more detail of the error. | [default to undefined]
|
|
19
|
+
**trackingId** | **(optional)** `string` | Unique tracking id for the error. | [default to undefined]
|
|
20
|
+
**messages** | **(optional)** `Array<Errormessagedto>` | Generic localized reason for error | [default to undefined]
|
|
21
|
+
**causes** | **(optional)** `Array<Errormessagedto>` | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined]
|
|
22
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-get-identity-intelligence-v1401-response
|
|
3
|
+
title: GetIdentityIntelligenceV1401Response
|
|
4
|
+
pagination_label: GetIdentityIntelligenceV1401Response
|
|
5
|
+
sidebar_label: GetIdentityIntelligenceV1401Response
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'GetIdentityIntelligenceV1401Response', 'v1GetIdentityIntelligenceV1401Response']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/get-identity-intelligence-v1401-response
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'GetIdentityIntelligenceV1401Response', 'v1GetIdentityIntelligenceV1401Response']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# GetIdentityIntelligenceV1401Response
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**error** | **(optional)** `any` | A message describing the error | [default to undefined]
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-get-identity-intelligence-v1429-response
|
|
3
|
+
title: GetIdentityIntelligenceV1429Response
|
|
4
|
+
pagination_label: GetIdentityIntelligenceV1429Response
|
|
5
|
+
sidebar_label: GetIdentityIntelligenceV1429Response
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'GetIdentityIntelligenceV1429Response', 'v1GetIdentityIntelligenceV1429Response']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/get-identity-intelligence-v1429-response
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'GetIdentityIntelligenceV1429Response', 'v1GetIdentityIntelligenceV1429Response']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# GetIdentityIntelligenceV1429Response
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**message** | **(optional)** `any` | A message describing the error | [default to undefined]
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: intelligence-models
|
|
3
|
+
title: Models
|
|
4
|
+
pagination_label: Models
|
|
5
|
+
sidebar_label: Models
|
|
6
|
+
sidebar_position: 4
|
|
7
|
+
sidebar_key: intelligence-typescript-models
|
|
8
|
+
sidebar_class_name: models
|
|
9
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'intelligence', 'models']
|
|
10
|
+
slug: /tools/sdk/typescript/intelligence/models
|
|
11
|
+
tags: ['SDK', 'Software Development Kit', 'intelligence', 'models']
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
|
|
15
|
+
|
|
16
|
+
## Key Features
|
|
17
|
+
- Attributes: Describe each attribute, including its name, data type, and whether it's required.
|
|
18
|
+
- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits.
|
|
19
|
+
- Example: Provides a sample of how the API uses the model.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelaccessaccountwire
|
|
3
|
+
title: Intelaccessaccountwire
|
|
4
|
+
pagination_label: Intelaccessaccountwire
|
|
5
|
+
sidebar_label: Intelaccessaccountwire
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelaccessaccountwire', 'v1Intelaccessaccountwire']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelaccessaccountwire
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelaccessaccountwire', 'v1Intelaccessaccountwire']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelaccessaccountwire
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**id** | `string` | Unique account identifier in Identity Security Cloud. | [default to undefined]
|
|
19
|
+
**name** | `string` | Account name or login value on the correlated source. | [default to undefined]
|
|
20
|
+
**source** | **(optional)** `Intelaccesssourcewire` | Source metadata for the account as returned by List Accounts wire format. | [default to undefined]
|
|
21
|
+
**disabled** | `boolean` | True when the account is administratively disabled on the source. | [default to undefined]
|
|
22
|
+
**locked** | `boolean` | True when the account is locked from interactive sign-in on the source. | [default to undefined]
|
|
23
|
+
**authoritative** | `boolean` | True when the account is treated as authoritative for attribute synchronization. | [default to undefined]
|
|
24
|
+
**systemAccount** | `boolean` | True when the account represents a non-interactive or system principal. | [default to undefined]
|
|
25
|
+
**isMachine** | `boolean` | True when the account belongs to a machine or service identity. | [default to undefined]
|
|
26
|
+
**manuallyCorrelated** | `boolean` | True when an administrator manually correlated the account to an identity. | [default to undefined]
|
|
27
|
+
**nativeIdentity** | **(optional)** `string` | Native identifier string on the source directory or application. | [default to undefined]
|
|
28
|
+
**created** | `string` | Timestamp when the account record was created in Identity Security Cloud. | [default to undefined]
|
|
29
|
+
**modified** | `string` | Timestamp when the account record was last modified in Identity Security Cloud. | [default to undefined]
|
|
30
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelaccesshistory
|
|
3
|
+
title: Intelaccesshistory
|
|
4
|
+
pagination_label: Intelaccesshistory
|
|
5
|
+
sidebar_label: Intelaccesshistory
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelaccesshistory', 'v1Intelaccesshistory']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelaccesshistory
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelaccesshistory', 'v1Intelaccesshistory']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelaccesshistory
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**accessItems** | `Intelaccesshistoryaccessitemsslice` | First page of access-item history events for the identity. | [default to undefined]
|
|
19
|
+
**certifications** | `Intelaccesshistorycertificationsslice` | First page of certification history events for the identity. | [default to undefined]
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelaccesshistoryaccessitemsslice
|
|
3
|
+
title: Intelaccesshistoryaccessitemsslice
|
|
4
|
+
pagination_label: Intelaccesshistoryaccessitemsslice
|
|
5
|
+
sidebar_label: Intelaccesshistoryaccessitemsslice
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelaccesshistoryaccessitemsslice', 'v1Intelaccesshistoryaccessitemsslice']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelaccesshistoryaccessitemsslice
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelaccesshistoryaccessitemsslice', 'v1Intelaccesshistoryaccessitemsslice']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelaccesshistoryaccessitemsslice
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**items** | `Array<Intelaccessitemhistoryevent>` | First page of access-item history events for the identity. | [default to undefined]
|
|
19
|
+
**next** | **(optional)** `string` | Absolute URL to the next access-items page; present only when more results exist. | [default to undefined]
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelaccesshistorycertificationsslice
|
|
3
|
+
title: Intelaccesshistorycertificationsslice
|
|
4
|
+
pagination_label: Intelaccesshistorycertificationsslice
|
|
5
|
+
sidebar_label: Intelaccesshistorycertificationsslice
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelaccesshistorycertificationsslice', 'v1Intelaccesshistorycertificationsslice']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelaccesshistorycertificationsslice
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelaccesshistorycertificationsslice', 'v1Intelaccesshistorycertificationsslice']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelaccesshistorycertificationsslice
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**items** | `Array<Intelcertificationhistoryevent>` | First page of certification history events for the identity. | [default to undefined]
|
|
19
|
+
**next** | **(optional)** `string` | Absolute URL to the next certifications page; present only when more results exist. | [default to undefined]
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelaccessitemhistoryevent
|
|
3
|
+
title: Intelaccessitemhistoryevent
|
|
4
|
+
pagination_label: Intelaccessitemhistoryevent
|
|
5
|
+
sidebar_label: Intelaccessitemhistoryevent
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelaccessitemhistoryevent', 'v1Intelaccessitemhistoryevent']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelaccessitemhistoryevent
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelaccessitemhistoryevent', 'v1Intelaccessitemhistoryevent']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelaccessitemhistoryevent
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**eventType** | `string` | Type of access-item history event. | [default to undefined]
|
|
19
|
+
**dateTime** | **(optional)** `string` | Event timestamp. | [default to undefined]
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelaccesssourcewire
|
|
3
|
+
title: Intelaccesssourcewire
|
|
4
|
+
pagination_label: Intelaccesssourcewire
|
|
5
|
+
sidebar_label: Intelaccesssourcewire
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelaccesssourcewire', 'v1Intelaccesssourcewire']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelaccesssourcewire
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelaccesssourcewire', 'v1Intelaccesssourcewire']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelaccesssourcewire
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**id** | **(optional)** `string` | Source identifier referenced by the account wire object. | [default to undefined]
|
|
19
|
+
**name** | **(optional)** `string` | Human-readable source name shown in administrative consoles. | [default to undefined]
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelaccountsslice
|
|
3
|
+
title: Intelaccountsslice
|
|
4
|
+
pagination_label: Intelaccountsslice
|
|
5
|
+
sidebar_label: Intelaccountsslice
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelaccountsslice', 'v1Intelaccountsslice']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelaccountsslice
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelaccountsslice', 'v1Intelaccountsslice']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelaccountsslice
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**items** | `Array<Intelaccessaccountwire>` | First page of accounts for the identity. | [default to undefined]
|
|
19
|
+
**next** | **(optional)** `string` | Absolute URL to the next accounts page; present only when more results exist. | [default to undefined]
|
|
20
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelcertificationhistoryevent
|
|
3
|
+
title: Intelcertificationhistoryevent
|
|
4
|
+
pagination_label: Intelcertificationhistoryevent
|
|
5
|
+
sidebar_label: Intelcertificationhistoryevent
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelcertificationhistoryevent', 'v1Intelcertificationhistoryevent']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelcertificationhistoryevent
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelcertificationhistoryevent', 'v1Intelcertificationhistoryevent']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelcertificationhistoryevent
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**eventType** | `string` | Type of certification history event. | [default to undefined]
|
|
19
|
+
**dateTime** | **(optional)** `string` | Event timestamp. | [default to undefined]
|
|
20
|
+
**certificationId** | **(optional)** `string` | Identifier of the certification. | [default to undefined]
|
|
21
|
+
**certificationName** | **(optional)** `string` | Display name of the certification. | [default to undefined]
|
|
22
|
+
**signedDate** | **(optional)** `string` | Timestamp when the certification was signed. | [default to undefined]
|
|
23
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelidentityaggregate
|
|
3
|
+
title: Intelidentityaggregate
|
|
4
|
+
pagination_label: Intelidentityaggregate
|
|
5
|
+
sidebar_label: Intelidentityaggregate
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelidentityaggregate', 'v1Intelidentityaggregate']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelidentityaggregate
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelidentityaggregate', 'v1Intelidentityaggregate']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelidentityaggregate
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**id** | `string` | Identity Security Cloud identifier for this identity. | [default to undefined]
|
|
19
|
+
**type** | `string` | Identity type for the matched record. | [default to undefined]
|
|
20
|
+
**displayName** | **(optional)** `string` | Preferred display name for the identity across administrative experiences. | [default to undefined]
|
|
21
|
+
**description** | **(optional)** `string` | Optional free-text description assigned to the identity profile when present. | [default to undefined]
|
|
22
|
+
**subtype** | **(optional)** `string` | NERM classification for the identity. | [default to undefined]
|
|
23
|
+
**owners** | **(optional)** `string` | Serialized owner reference information when populated by upstream identity services. | [default to undefined]
|
|
24
|
+
**attributes** | **(optional)** | Arbitrary SCIM-style attribute bag returned for the identity context view. | [default to undefined]
|
|
25
|
+
**created** | **(optional)** `string` | Timestamp when the identity record was created in Identity Security Cloud. | [default to undefined]
|
|
26
|
+
**modified** | **(optional)** `string` | Timestamp when the identity record was last modified in Identity Security Cloud. | [default to undefined]
|
|
27
|
+
**alias** | **(optional)** `string` | Primary login or account alias for the identity. | [default to undefined]
|
|
28
|
+
**email** | **(optional)** `string` | Primary business email address for the identity. | [default to undefined]
|
|
29
|
+
**identityStatus** | **(optional)** `string` | Current identity lifecycle status label from Identity Security Cloud. | [default to undefined]
|
|
30
|
+
**isManager** | **(optional)** `boolean` | True when the identity is flagged as a people manager in the organization. | [default to false]
|
|
31
|
+
**accounts** | `Intelaccountsslice` | First page of accounts for the identity. | [default to undefined]
|
|
32
|
+
**privilegedAccess** | `Intelprivilegedaccessslice` | Full privileged access result for the identity. | [default to undefined]
|
|
33
|
+
**outliers** | **(optional)** `Inteloutliersslice` | Rare access slice; omitted when the tenant lacks the IDA-outliers license. | [default to undefined]
|
|
34
|
+
**accessHistory** | `Intelaccesshistory` | Access-history split into access items and certifications sub-slices. | [default to undefined]
|
|
35
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-inteloutlieraccessitem
|
|
3
|
+
title: Inteloutlieraccessitem
|
|
4
|
+
pagination_label: Inteloutlieraccessitem
|
|
5
|
+
sidebar_label: Inteloutlieraccessitem
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Inteloutlieraccessitem', 'v1Inteloutlieraccessitem']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/inteloutlieraccessitem
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Inteloutlieraccessitem', 'v1Inteloutlieraccessitem']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Inteloutlieraccessitem
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**id** | `string` | Stable identifier of the outlier access-item row. | [default to undefined]
|
|
19
|
+
**displayName** | `string` | Display label of the risky access item. | [default to undefined]
|
|
20
|
+
**description** | **(optional)** `string` | Optional descriptive text for the risky access item. | [default to undefined]
|
|
21
|
+
**accessType** | `string` | Access item type. | [default to undefined]
|
|
22
|
+
**sourceName** | `string` | Source name where the risky access item exists. | [default to undefined]
|
|
23
|
+
**extremelyRare** | `boolean` | Indicates whether analytics marked this item as extremely rare. | [default to undefined]
|
|
24
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-inteloutliersslice
|
|
3
|
+
title: Inteloutliersslice
|
|
4
|
+
pagination_label: Inteloutliersslice
|
|
5
|
+
sidebar_label: Inteloutliersslice
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Inteloutliersslice', 'v1Inteloutliersslice']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/inteloutliersslice
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Inteloutliersslice', 'v1Inteloutliersslice']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Inteloutliersslice
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**rareAccess** | `Intelrareaccessslice` | First page of rare access items for the identity. | [default to undefined]
|
|
19
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-intelprivilegedaccessitemwire
|
|
3
|
+
title: Intelprivilegedaccessitemwire
|
|
4
|
+
pagination_label: Intelprivilegedaccessitemwire
|
|
5
|
+
sidebar_label: Intelprivilegedaccessitemwire
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Intelprivilegedaccessitemwire', 'v1Intelprivilegedaccessitemwire']
|
|
8
|
+
slug: /tools/sdk/typescript/intelligence/models/intelprivilegedaccessitemwire
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Intelprivilegedaccessitemwire', 'v1Intelprivilegedaccessitemwire']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Intelprivilegedaccessitemwire
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**privileged** | `boolean` | True when this item is classified as privileged access for the identity. | [default to undefined]
|
|
19
|
+
**id** | `string` | Identifier of the privileged access item. | [default to undefined]
|
|
20
|
+
**type** | `string` | Type of privileged access object. | [default to undefined]
|
|
21
|
+
**displayName** | **(optional)** `string` | Display label for the privileged access item in administrative experiences. | [default to undefined]
|
|
22
|
+
**name** | **(optional)** `string` | Technical name of the privileged access item. | [default to undefined]
|
|
23
|
+
**source** | **(optional)** `IntelprivilegedaccessitemwireSource` | | [default to undefined]
|
|
24
|
+
**attribute** | **(optional)** `string` | Source attribute name that carries the privileged value when applicable. | [default to undefined]
|
|
25
|
+
**value** | **(optional)** `string` | Privileged value on the source attribute when applicable. | [default to undefined]
|
|
26
|
+
|