Method: organizations.locations.entitlements.create
Creates a new entitlement in a given project/folder/organization and location.
HTTP request
POST https://privilegedaccessmanager.googleapis.com/v1beta/{parent=organizations/*/locations/*}/entitlements
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. Name of the parent resource for the entitlement. Possible formats:
organizations/{organization-number}/locations/{region}folders/{folder-number}/locations/{region}projects/{project-id|project-number}/locations/{region}
|
Query parameters
| Parameters |
entitlementId |
string
Required. The ID to use for this entitlement. This becomes the last part of the resource name. This value should be 4-63 characters in length, and valid characters are "[a-z]", "[0-9]", and "-". The first character should be from [a-z]. This value should be unique among all other entitlements under the specified parent.
|
requestId |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request and returns the previous operation's response. This prevents clients from accidentally creating duplicate entitlements. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
Request body
The request body contains an instance of Entitlement.
Response body
If successful, the response body contains a newly created instance of Operation.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent resource:
privilegedaccessmanager.entitlements.create
For more information, see the IAM documentation.
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 API endpoint creates a new entitlement within a specified project, folder, or organization and location using a POST HTTP request.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required to specify the resource under which the entitlement will be created, and \u003ccode\u003eentitlementId\u003c/code\u003e is a required query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include an \u003ccode\u003eEntitlement\u003c/code\u003e instance, and the server's response, upon success, will contain an \u003ccode\u003eOperation\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully create an entitlement, the request requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003eprivilegedaccessmanager.entitlements.create\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],[],null,["# Method: organizations.locations.entitlements.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nCreates a new entitlement in a given project/folder/organization and location.\n\n### HTTP request\n\n`POST https://privilegedaccessmanager.googleapis.com/v1beta/{parent=organizations/*/locations/*}/entitlements`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Entitlement](/iam/docs/reference/pam/rest/v1beta/folders.locations.entitlements#Entitlement).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/iam/docs/reference/pam/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `privilegedaccessmanager.entitlements.create`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
