Identity Posture GraphQL API๐
Query๐
Description: Public queries
Fields๐
| Field | Type | Description | Arguments |
|---|---|---|---|
| identityPosture | IdentityPostureReportResult | Gets the cached posture report for a configured identity provider. | type: IdentityPostureReportType, provider: ID |
| identityPostures | IdentityPostureReportResult | Gets all the posture reports for a provider that have been previously ran. Note that the results will not include the raw data, use the identityPosture query to get the raw data. | provider: ID |
| identityPostureTypes | IdentityPostureReportDefinition | Provides a list of all possible report types. | |
| lastRanReportTime | Time | Gets the last time a report ran for a provider or tenant. If no provider is provided, it will be the last time a report ran for the tenant. If no report has ran, it will return null. | provider: ID |
ID๐
Description: The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
IdentityPostureReportType๐
Description: Reports that can be generated for a provider.
IdentityPostureReportStatus๐
Description: Report statuses.
IdentityProviderType๐
Description: An identity provider type.
IdentityPostureReportDefinition๐
Description: A report that can be ran.
Fields๐
| Field | Type | Description | Arguments |
|---|---|---|---|
| type | IdentityPostureReportType | Unique type of the report. | |
| supportedProviderTypes | IdentityProviderType | What types of provider are supported for this report. | |
| description | String | Summary of the report. | |
| defaultRunInterval | String | How frequently the report should be run. Empty means the report should not be run automatically. Examples: 1h, 1d, 1w, 1m. |
String๐
Description: The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
IdentityPostureReportResult๐
Description: Output report for a provider.
Fields๐
| Field | Type | Description | Arguments |
|---|---|---|---|
| definition | IdentityPostureReportDefinition | Report definition | |
| providerId | ID | Id of IdP | |
| status | IdentityPostureReportStatus | The status of the report | |
| data | Map | The report data | |
| summary | String | Optional summary of the report output | |
| metrics | IdentityPostureReportResultMetrics | Metrics for the report |
IdentityPostureReportResultMetrics๐
Description: Metrics for a posture report.
Fields๐
| Field | Type | Description | Arguments |
|---|---|---|---|
| startTime | Time | When the report was started. If null, the report has never been run. | |
| endTime | Time | When the report was finished. If the report is still running and has no previous results, this will be null. | |
| attempts | Int64 | The number of attempts to generate the report. | |
| errors | String | Any non-fatal errors that occurred while generating the report. |
Time๐
Description: A timestamp type.
Map๐
Description: A map type.
Int64๐
Description: A scalar for 64-bit integers.
Boolean๐
Description: The Boolean scalar type represents true or false.