Method: projects.locations.entitlements.search
entitlements.search
returns entitlements on which the caller has the specified access.
HTTP request
GET https://privilegedaccessmanager.googleapis.com/v1/{parent=projects/*/locations/*}/entitlements:search
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
Required. The parent which owns the entitlement resources.
|
Query parameters
Parameters |
callerAccessType |
enum (CallerAccessType )
Required. Only entitlements where the calling user has this access are returned.
|
filter |
string
Optional. Only entitlements matching this filter are returned in the response.
|
pageSize |
integer
Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.
|
pageToken |
string
Optional. A token identifying a page of results the server should return.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of SearchEntitlementsResponse
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eThis endpoint, \u003ccode\u003eentitlements.search\u003c/code\u003e, retrieves entitlements based on the caller's access, utilizing the \u003ccode\u003eGET\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is mandatory, specifying the resource's ownership context, while the \u003ccode\u003ecallerAccessType\u003c/code\u003e query parameter is also required, determining the type of access the user has on the returned entitlements.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters, including \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, and \u003ccode\u003epageToken\u003c/code\u003e, allow for refined and paginated search results.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this endpoint must be empty, and successful responses will contain an instance of \u003ccode\u003eSearchEntitlementsResponse\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,[]]