What is the default and maximum page size for Directory Role APIs.

linux-user 0

I'm trying to integrate Directory Role API with another service.

Example: List Directory Roles
Ref: Optional Query Param

If $top is not supported with this API using, What is the default behavior from the server side for Directory Role API? Is it going to send all of the records in the response or it will paginate the response based on some default / maximum page size?

If the server paginate the response based on some default/max page size, will it send nextLink
in the response? If so then does it support skipToken?

1 answer

Harpreet Singh Matharoo 7,621 Reputation points Microsoft Employee

2024-03-13T04:52:47.5+00:00

Hello @linux-user ,

Thank you for contacting Microsoft Azure QnA platform. I would like to confirm that most of the Graph API use the concept called pagination to manage the retrieval of large data sets. Same is the case with Directory Role API.

List Directory Roles operation does not support the $top query parameter for pagination. Instead, it returns a default set of objects. At times the page length is defaulted to 999 items, This means that if there are more than 999 items, the API will return the first 1,000 roles in the initial response.

If there are more roles to retrieve, the API includes an @odata.nextLink property in the response. This property contains a URL that you can use to retrieve the next page of results3. You should include the entire URL in the @odata.nextLink property in your request for the next page of results. More details about paging and @odata.nextLink property can be found on following document: https://learn.microsoft.com/en-us/graph/best-practices-concept#pagination

The @odata.nextLink URL value contains a $skiptoken query parameter. The $skiptoken is an opaque value that points to the next page of results. You should not try to extract the $skiptoken value and use it in a different request.

Please note that the behavior of APIs can vary, and it’s always a good idea to refer to the specific API documentation for the most accurate and up-to-date information. In this case, you may refer to the Microsoft Graph documentation for more details.

I hope this answer helps to resolve your issue. Please "Accept the answer" if the information helped you. This will help us and others in the community as well.
Please sign in to rate this answer.
linux-user 0 Reputation points

2024-03-13T05:59:41.18+00:00

Hey @Harpreet Singh Matharoo , Thank you for replying!

Here are my findings based on the available documentation for the Directory Role:

It is mentioned in the paging document that Directory Roles does not support Paging (ref: Things to consider with paged data)

Directory Roles does not support $skipToken, $skip query params to customize the response. (ref: List of optional query params)

If we assume that, it still sends @data.nextLink in case there are more records than the default page size 999 , What will be the content of @data.NextLink ? Will it contain the $skipToken? How can we use this link if the directory Role does not support $skipToken?

Debugging Directory Role API using the Postman client:

Passing a dummy token to List Directory Role API returns an error Request_UnsupportedQuery ie. Paging is not currently supported for role queries.

Can you clarify the following questions?

Will List Directory Role API return all the records in a single response?

Is there any documentation reference to understand the default page size of a particular API?

Harpreet Singh Matharoo 7,621 Reputation points Microsoft Employee

2024-03-13T07:42:48.24+00:00

I tested the API Query and it returned all 38 directory roles for my tenant.

Reading the document: https://learn.microsoft.com/en-us/graph/api/directoryrole-list?view=graph-rest-1.0&tabs=http it seems that this query would only return roles that have been activated. Which means if a role has a permanent role assigned or has been activated only then it would be returned.

Assuming this I feel the number of directory roles should be well below the default page size of 999 items.

linux-user 0 Reputation points

2024-03-13T15:01:18.37+00:00

Hi @Harpreet Singh Matharoo ,

What is the API behavior with $expand=members for directory Roles?

Let's consider a scenario where directory roles contain over 2000 member records each. According to the documentation (reference: Know Limitations for query parameters), when $expand is used:

For directory objects, returns a maximum of 100 objects.

No support for @data.nextLink.

Here we can't retrieve records more than 100 ? Or this is the default page Size?

So, if I aim to retrieve all the role members for every directory role, what approach should I take to obtain all records?

Above mentioned

List members of a directory role

List a user's direct memberships

Thank You!

Harpreet Singh Matharoo 7,621 Reputation points Microsoft Employee

2024-03-19T08:10:33.96+00:00

@linux-user Please find responses below:

When we list member assigned to specific directory role we are not using $expand variable. Instead we use list member API query. Please repro from my test environment.

To test the behavior I assigned almost 1300 members as active assignments to directory reader role using following script:

Connect-MgGraph -Scopes RoleManagement.ReadWrite.Directory $ObjectId= Import-Csv -Path C:\Users\Harpreet\Desktop\ObjectID.csv # Displays the Directory Readers role information $roleDefinition = Get-MgRoleManagementDirectoryRoleDefinition -Filter "DisplayName eq 'Directory Readers'" Foreach ($Object in $ObjectId) { # Assigns the Directory Readers role $roleAssignment = New-MgRoleManagementDirectoryRoleAssignment -DirectoryScopeId '/' -RoleDefinitionId $roleDefinition.Id -PrincipalId $Object.Id $roleAssignment }

Later I used API Query: https://graph.microsoft.com/v1.0/directoryRoles/143dcfc3-8865-4c64-9023-11e9d25b4792/members?$select=displayName to list display names of all the users added as member on Directory Reader role.

I found that this does presents @data.nextLink since the since page size is more than 1000 objects.

Please review the screenshots below for validation:

@data.nextLink presented in 1st repsonse since the page size is more than 1000 objects.

Rest of the Data exported using @data.nextLink

To answer your query in short when using List members of a directory role you would get @data.nextLink if the page size is more than 1000 objects.

I hope this helps.
Sign in to comment

Share via

What is the default and maximum page size for Directory Role APIs.

1 answer