Note: if you are running CloudGraph locally you can view the interactive, automatically generated documentation in either GraphQL Playground or Altair by clicking the docs button on the right-hand side of the screen. After reading the below information we highly suggest you use one of these tools to test your queries as they will autocomplete fields for you and let you know if your queries are valid before you even submit them.
Overview
You can currently query the following attributes on an Authorization Role Assignment
GraphQL
|
query{queryazureAuthRoleAssignment{idnametyperegionsubscriptionIdscoperoleDefinitionIdprincipalIdprincipalTypecanDelegateapplications{id# Other fields and connections here...}groups{id# Other fields and connections here...}roleDefinition{id# Other fields and connections here...}servicePrincipals{id# Other fields and connections here...}users{id# Other fields and connections here...}}}
Filtering
Get data for a single Authorization Role Assignment key that you know the ID for:
GraphQL
|
query{getazureAuthRoleAssignment(id:"12345"){id# Other fields here...}}
Get data for all of the Authorization Role Assignments in a certain Azure subscription:
GraphQL
|
query{queryazureAuthRoleAssignment(filter:{subscriptionId:{eq:"12345"}}){id# Other fields and connections here...}}# Note that in addition to "subscriptionId" you can# Filter based on any of the following attributes:# id# name# type# region# subscriptionId# scope# roleDefinitionId# principalId# principalType# canDelegate# And the following Dgraph filters can also be applied:# has# and# or# not# regexp (regular expressions)# fulltext filters# alloftext# anyoftext
Get data for all of the Authorization Role Assignments that are NOT in a certain Azure subscription:
GraphQL
|
query{queryazureAuthRoleAssignment(filter:{not:{subscriptionId:{eq:"12345"}}}){id# Other fields and connections here...}}
Advanced Filtering
Get data for all of the Authorization Role Assignments that are connected to an application:
GraphQL
|
query{queryazureAuthRoleAssignment(filter:{has:applications}){id# Other fields and connections here...}}# Note that in addition to "applications" you can filter# Using "has" based on any of the following attributes:# id# name# type# region# subscriptionId# scope# roleDefinitionId# principalId# principalType# canDelegate# groups# roleDefinition # servicePrincipals # users
Ordering
You can order the results you get back either asc or desc depending on your preference:
GraphQL
|
query{queryazureAuthRoleAssignment(order:{desc:name}){id# Other fields and connections here...}}# Note that in addition to "name" you can filter# Using "asc" or "desc" based on any of the following attributes:# id# name# type# region# subscriptionId# scope# roleDefinitionId# principalId# principalType# canDelegate
Only select and return the first two Azure Authorization Role Assignments that are found:
GraphQL
|
query{queryazureAuthRoleAssignment(first:2,order:{desc:name}){id# Other fields and connections here...}}
Only select and return the first two Authorization Role Assignments that are found, but offset by one so keys two & three are returned:
GraphQL
|
query{queryazureAuthRoleAssignment(first:2,order:{desc:name},offset:1){id# Other fields and connections here...}}
Aggregation
Count the number of Authorization Role Assignments across all scanned Azure subscriptions:
GraphQL
|
query{aggregateazureAuthRoleAssignment{count# Other fields and connections here...}}# Note that in addition to "count" you can request the# Following min and max values based on attributes of your Authorization Role Assignment:# idMin# idMax# nameMin# nameMax# typeMin# typeMax# regionMin# regionMax# subscriptionIdMin# subscriptionIdMax# scopeMin# scopeMax# roleDefinitionIdMin# roleDefinitionIdMax# principalIdMin# principalIdMax# principalTypeMin# principalTypeMax
Count the number of Authorization Role Assignments in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query{aggregateazureAuthRoleAssignment(filter:{subscriptionId:{eq:"12345"}}){count# Other fields and connections here...}}
Examples
Find all of the Authorization Role Assignments that are in the eastus region across all your accounts:
GraphQL
|
query{queryazureAuthRoleAssignment(filter:{region:{eq:"eastus"}}){id# Other fields and connections here...}}
Kitchen Sink
Putting it all together; get all data for all Authorization Role Assignments across all regions for all scanned Azure subscriptions in a single query:
GraphQL
|
query{queryazureAuthRoleAssignment{idnametyperegionsubscriptionIdscoperoleDefinitionIdprincipalIdprincipalTypecanDelegateapplications{idregionappIdapplicationTemplateIdapiAcceptMappedClaimsapiKnownClientApplicationsapiPreAuthorizedApplicationsappRoles{idallowedMemberTypesdescriptiondisplayNameisEnabledoriginvalue}createdDateTimedescriptiondisabledByMicrosoftStatusdisplayNamegroupMembershipClaimsidentifierUrisisDeviceOnlyAuthSupportedisFallbackPublicClientnotesoauth2RequirePostResponsepublicClientRedirectUrispublisherDomainsignInAudiencespaApplicationRedirectUriswebAppHomePageUrlwebAppRedirectUristags{idkeyvalue}authRoleAssignments{id# Other fields and connections here...}instancedBy{id# Other fields and connections here...}ownerGroups{id# Other fields and connections here...}ownerServicePrincipals{id# Other fields and connections here...}ownerUsers{id# Other fields and connections here...}}groups{iddeletedDateTimeclassificationcreatedDateTimedescriptiondisplayNameexpirationDateTimegroupTypesisAssignableToRolemailmailEnabledmailNicknamemembershipRulemembershipRuleProcessingStateonPremisesDomainNameonPremisesLastSyncDateTimeonPremisesNetBiosNameonPremisesSamAccountNameonPremisesSecurityIdentifieronPremisesSyncEnabledpreferredDataLocationpreferredLanguageproxyAddressesrenewedDateTimesecurityEnabledvisibilityallowExternalSendersisSubscribedByMailisArchivedpermissionGrants{idclientAppIdclientIdpermissionpermissionTyperesourceAppId}settings{iddeletedDateTimedisplayNametemplateIdvalues{idnamevalue}}appOwnerOf{id# Other fields and connections here...}authRoleAssignments{id# Other fields and connections here...}}roleDefinition{idnametyperegionsubscriptionIdroleNamedescriptionroleTypepermissions{idactionsnotActionsdataActionsnotDataActions}assignableScopes}servicePrincipals{iddeletedDateTimeaccountEnabledalternativeNamesappDescriptionappDisplayNameappIdapplicationTemplateIdappOwnerOrganizationIdappRoleAssignmentRequiredappRoles{id# Other fields and connections here...}descriptiondisabledByMicrosoftStatusdisplayNamehomepageloginUrllogoutUrlnotesnotificationEmailAddressespreferredSingleSignOnModereplyUrlsservicePrincipalNamesservicePrincipalTypesignInAudiencetokenEncryptionKeyIdappRoleAssignedTo{id# Other fields and connections here...}appRoleAssignments{id# Other fields and connections here...}endpoints{iddeletedDateTimecapabilityproviderIdproviderNameproviderResourceIduri}tags{idkeyvalue}appOwnerOf{id# Other fields and connections here...}instanceOf{id# Other fields and connections here...}authRoleAssignments{id# Other fields and connections here...}}users{iddeletedDateTimeaccountEnabledageGroupcitycompanyNamecountrycreatedDateTimecreationTypedepartmentdisplayNameemployeeHireDateemployeeIdemployeeTypeexternalUserStateexternalUserStateChangeDateTimegivenNameisResourceAccountlastPasswordChangeDateTimemailmailNicknameofficeLocationonPremisesDistinguishedNameonPremisesDomainNameonPremisesImmutableIdonPremisesLastSyncDateTimeonPremisesSyncEnabledonPremisesUserPrincipalNameotherMailspasswordPoliciespreferredLanguageproxyAddressesstatesurnameusageLocationuserPrincipalNameuserTypepreferredNameresponsibilitiesappOwnerOf{id# Other fields and connections here...}appRoleAssignments{id# Other fields and connections here...}authRoleAssignments{id# Other fields and connections here...}}}}
