OBJECT

ManagementEndpointQuery

link GraphQL Schema definition

  • type ManagementEndpointQuery {
  • # Get cloud proxy download info
  • #
  • # Arguments
  • # serviceType: [Not documented]
  • queryCloudProxyAgentDownloadInfo(
  • serviceType: ManagementEndpointServiceType!
  • ): ManagementEndpointAgentDownloadInfo
  • # Query a filtered set of management endpoint collectors for aggregated counts of
  • # values of specified fields and all preexisting values
  • #
  • # This can be used, for example, to fetch counts of each collectors and their
  • # types.
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # queryFilter: [Not documented]
  • queryCollectorAggregations(
  • aggregations: [ManagementEndpointAggregationInput!]!,
  • queryFilter: ManagementEndpointCollectorQueryFilter
  • ): ManagementEndpointAggregations!
  • # Query all/specific credential definition
  • #
  • # Arguments
  • # credentialDefinitionIds: List of Credential Definition Ids to
  • # fetch
  • # filter: Filters for fetching credential definitions
  • queryCredentialDefinitions(
  • credentialDefinitionIds: [String!],
  • filter: ManagementEndpointDefinitionQueryFilter
  • ): [ManagementEndpointCredentialDefinition!]
  • # Query discovered accounts for a given administrative account id.
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # Arguments
  • # input: [Not documented]
  • queryDiscoveredAccounts(
  • input: ManagementEndpointDiscoveredAccountInput
  • ): ManagementEndpointDiscoveredAccountResponse
  • # Query all/specific endpoint definition
  • #
  • # Arguments
  • # endpointDefinitionIds: List of Endpoint Definition Ids to fetch
  • # filter: Filters for fetching endpoint definitions
  • queryEndpointDefinitions(
  • endpointDefinitionIds: [String!],
  • filter: ManagementEndpointDefinitionQueryFilter
  • ): [ManagementEndpointDefinition!]
  • # Query to get download link for lifecycle script
  • #
  • # Arguments
  • # endpointType: [Not documented]
  • queryLifeCycleScriptDownloadInfo(
  • endpointType: ManagementEndpointType!
  • ): ManagementEndpointLifecycleScriptDownloadInfo
  • # Query a filtered set of management endpoints for aggregated counts of values of
  • # specified fields and all preexisting values
  • #
  • # This can be used, for example, to fetch counts of AWS services and their types,
  • # or to fetch existing values of a field e.g. for autocomplete / selection
  • # drop-down
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # queryFilter: [Not documented]
  • queryManagementEndpointAggregations(
  • aggregations: [ManagementEndpointAggregationInput!]!,
  • queryFilter: ManagementEndpointQueryFilter
  • ): ManagementEndpointAggregations!
  • # Query all management endpoint collectors by various parameters
  • #
  • # Arguments
  • # after: relay-compatible cursor of last entry on previous page
  • # first: relay-compatible page size
  • # id: filter by management endpoint collector ID(s)
  • # managementEndpointCollectorHealthStatus: filter by management
  • # endpoint collector status Online/Offline/NA
  • # managementEndpointCollectorStatus: filter by management
  • # endpoint collector status Discovered/Ready/Pending
  • # managementEndpointId: filter by management endpoint ID(s)
  • # name: filter by management endpoint collector names
  • # sort: [Not documented]
  • # type: filter by management endpoint collector types
  • queryManagementEndpointCollectors(
  • after: String,
  • first: Int,
  • id: [ID!],
  • managementEndpointCollectorHealthStatus: [ManagementEndpointCollectorHealthStatus!],
  • managementEndpointCollectorStatus: [ManagementEndpointCollectorStatus!],
  • managementEndpointId: [ID!],
  • name: [String!],
  • sort: [QuerySort!],
  • type: [ManagementEndpointCollectorType!]
  • ): ManagementEndpointCollectorConnection
  • # Query all credential brokers
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # Arguments
  • # after: relay-compatible cursor of last entry on previous page
  • # credentialBrokerHealthStatus: filter by credential broker
  • # health status ONLINE/OFFLINE/UNKNOWN
  • # credentialBrokerStatus: filter by credential broker status
  • # Ready/Pending
  • # first: relay-compatible page size
  • # id: filter by credential broker ID(s)
  • # sort: [Not documented]
  • queryManagementEndpointCredentialBrokers(
  • after: String,
  • credentialBrokerHealthStatus: [ManagementEndpointCredentialBrokerHealthStatus!],
  • credentialBrokerStatus: [ManagementEndpointCredentialBrokerRegistrationStatus!],
  • first: Int,
  • id: [ID!],
  • sort: [QuerySort!]
  • ): ManagementEndpointCredentialBrokerConnection
  • # Query details of credential usages by different stakeholders (sources) for a
  • # given management endpoint
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # Arguments
  • # after: Fetch records after given cursor
  • # filter: Filters for fetching credential usage
  • # first: Limit the number of entries in response to the first N
  • # managementEndpointId: Management endpoint id for which
  • # credential usage should be fetched
  • queryManagementEndpointCredentialUsage(
  • after: String,
  • filter: ManagementEndpointCredentialUsageFilter,
  • first: Int,
  • managementEndpointId: String!
  • ): ManagementEndpointCredentialUsageConnection
  • # Query all management endpoints credentials.
  • #
  • # Arguments
  • # after: relay-compatible cursor of last entry on previous page
  • # before: relay-compatible cursor of first entry on current page
  • # credentialName: filter by credential name
  • # credentialType: filter by Management Endpoint Credential Type
  • # cspProjectEntityIds: filter by CSP Project Entity ID(s)
  • # cspProjectIds: filter by CSP Project ID(s)
  • # filter: Full text search Filter for more advanced filtering
  • # Supported fields for filtering are:
  • #
  • # targetId
  • # first: relay-compatible page size
  • # id: filter by credential ID(s)
  • # last: relay-compatible page size
  • # permissionType: filter by credential permission type
  • # reusableOnly: filter to only return credentials which may be
  • # reusable across management endpoints
  • # scope: filter by scope
  • # sort: [Not documented]
  • queryManagementEndpointCredentials(
  • after: String,
  • before: String,
  • credentialName: String,
  • credentialType: ManagementEndpointCredentialType,
  • cspProjectEntityIds: [EntityId!],
  • cspProjectIds: [String!],
  • filter: QueryFilter,
  • first: Int,
  • id: [ID!],
  • last: Int,
  • permissionType: ManagementEndpointCredentialPermissionType,
  • reusableOnly: Boolean,
  • scope: [ManagementEndpointCredentialScope!],
  • sort: [QuerySort!]
  • ): ManagementEndpointCredentialConnection
  • # Query all management endpoints.
  • #
  • # Arguments
  • # after: relay-compatible cursor of last entry on previous page
  • # before: relay-compatible cursor of first entry on current page
  • # credentialIds: filter by credential IDs
  • # cspProjectEntityIds: filter by CSP Project Entity ID(s)
  • # cspProjectIds: filter by CSP Project ID(s)
  • # endpointName: filter by endpoint name(s)
  • # endpointNamePrefix: filter by endpoint name prefix
  • # filter: Additional field filters are currently not supported.
  • # first: relay-compatible page size
  • # last: relay-compatible page size
  • # managementEndpointAccountStatus: filter by Management endpoint
  • # account status
  • # managementEndpointId: filter by management endpoint ID(s)
  • # managementEndpointType: filter by Management Endpoint Types
  • # permissionType: filter by credential permission type
  • # rootManagementEndpointEntityId: filter member accounts by root
  • # account entity id
  • # rootManagementEndpointId: filter member accounts by root
  • # account id
  • # sort: Supported sort fields:
  • #
  • # 'endpointName'
  • #
  • # 'endpointType'
  • #
  • # 'creationTime'
  • #
  • # 'lastUpdateTime'
  • #
  • # 'managementEndpointStatus.status'
  • queryManagementEndpoints(
  • after: String,
  • before: String,
  • credentialIds: [String!],
  • cspProjectEntityIds: [EntityId!],
  • cspProjectIds: [String!],
  • endpointName: [String!],
  • endpointNamePrefix: String,
  • filter: QueryFilter,
  • first: Int,
  • last: Int,
  • managementEndpointAccountStatus: ManagementEndpointDeploymentStatus,
  • managementEndpointId: [String!],
  • managementEndpointType: [ManagementEndpointType!],
  • permissionType: ManagementEndpointCredentialPermissionType,
  • rootManagementEndpointEntityId: [EntityId!],
  • rootManagementEndpointId: [String!],
  • sort: [QuerySort!]
  • ): ManagementEndpointConnection
  • # Query to get count of member accounts with elevated credential
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # Arguments
  • # permissionType: Credential Permission Type
  • # rootAccountId: Root Account Id
  • queryMemberAccountsByCredPermissionType(
  • permissionType: ManagementEndpointCredentialPermissionType!,
  • rootAccountId: String!
  • ): ManagementEndpointMemberAccountsByCredPermissionTypeResponse
  • }

link Require by