{ "canonicalName": "Privileged Access Manager", "kind": "discovery#restDescription", "documentationLink": "https://cloud.google.com/iam/docs/pam-overview", "protocol": "rest", "basePath": "", "ownerName": "Google", "revision": "20260506", "discoveryVersion": "v1", "baseUrl": "https://privilegedaccessmanager.googleapis.com/", "servicePath": "", "title": "Privileged Access Manager API", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "rootUrl": "https://privilegedaccessmanager.googleapis.com/", "schemas": { "ManualApprovals": { "properties": { "steps": { "items": { "$ref": "Step" }, "description": "Optional. List of approval steps in this workflow. These steps are followed in the specified order sequentially. Only 1 step is supported.", "type": "array" }, "requireApproverJustification": { "description": "Optional. Do the approvers need to provide a justification for their actions?", "type": "boolean" } }, "description": "A manual approval workflow where users who are designated as approvers need to call the `ApproveGrant`/`DenyGrant` APIs for a grant. The workflow can consist of multiple serial steps where each step defines who can act as approver in that step and how many of those users should approve before the workflow moves to the next step. This can be used to create approval workflows such as: * Require an approval from any user in a group G. * Require an approval from any k number of users from a Group G. * Require an approval from any user in a group G and then from a user U. A single user might be part of the `approvers` ACL for multiple steps in this workflow, but they can only approve once and that approval is only considered to satisfy the approval step at which it was granted.", "type": "object", "id": "ManualApprovals" }, "ExternallyModified": { "properties": {}, "description": "An event representing that the policy bindings made by this grant were modified externally.", "type": "object", "id": "ExternallyModified" }, "SearchGrantsResponse": { "properties": { "grants": { "items": { "$ref": "Grant" }, "description": "The list of grants.", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "id": "SearchGrantsResponse", "description": "Response message for `SearchGrants` method.", "type": "object" }, "NotMandatory": { "description": "The justification is not mandatory but can be provided in any of the supported formats.", "type": "object", "id": "NotMandatory", "properties": {} }, "SettingsEmailNotificationSettings_CustomNotificationBehavior": { "properties": { "approverNotifications": { "description": "Optional. Approver email notifications.", "$ref": "SettingsEmailNotificationSettingsCustomNotificationBehavior_ApproverNotifications" }, "adminNotifications": { "description": "Optional. Admin email notifications.", "$ref": "SettingsEmailNotificationSettingsCustomNotificationBehavior_AdminNotifications" }, "requesterNotifications": { "description": "Optional. Requester email notifications.", "$ref": "SettingsEmailNotificationSettingsCustomNotificationBehavior_RequesterNotifications" } }, "id": "SettingsEmailNotificationSettings_CustomNotificationBehavior", "description": "`CustomNotificationBehavior` provides granular control over email notification delivery. Allows admins to selectively enable/disable notifications for specific events and specific personas.", "type": "object" }, "FetchEffectiveSettingsResponse_ServiceAccountApproverSettings": { "properties": { "enabled": { "readOnly": true, "description": "Output only. Indicates whether service account is allowed to grant approvals.", "type": "boolean" }, "source": { "description": "Output only. The resource from which the service account approver setting is inherited. This field remains empty if the setting is not defined at either the parent or resource level, in which case PAM's default behavior is applied.", "type": "string", "readOnly": true } }, "id": "FetchEffectiveSettingsResponse_ServiceAccountApproverSettings", "description": "This controls whether service accounts are allowed to approve grants or can be designated as approvers within PAM entitlements.", "type": "object" }, "Ended": { "description": "An event representing that the grant has ended.", "type": "object", "id": "Ended", "properties": {} }, "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_RequesterNotifications": { "description": "Email notifications specific to Requesters.", "type": "object", "id": "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_RequesterNotifications", "properties": { "notifyGrantActivated": { "readOnly": true, "description": "Output only. Notification delivery for grant activated.", "type": "boolean" }, "notifyGrantExpired": { "description": "Output only. Notification delivery for grant request expired.", "type": "boolean", "readOnly": true }, "notifyGrantExternallyModified": { "readOnly": true, "description": "Output only. Notification delivery for grant externally modified.", "type": "boolean" }, "notifyEntitlementAssigned": { "description": "Output only. Notification delivery for entitlement assigned.", "type": "boolean", "readOnly": true }, "notifyGrantActivationScheduled": { "readOnly": true, "description": "Output only. Notification delivery for grant activation scheduled.", "type": "boolean" }, "notifyGrantActivationFailed": { "description": "Output only. Notification delivery for grant activation failed.", "type": "boolean", "readOnly": true }, "notifyGrantDenied": { "readOnly": true, "description": "Output only. Notification delivery for grant denied.", "type": "boolean" }, "notifyGrantEnded": { "readOnly": true, "description": "Output only. Notification delivery for grant ended.", "type": "boolean" }, "notifyGrantRevoked": { "readOnly": true, "description": "Output only. Notification delivery for grant revoked.", "type": "boolean" } } }, "Operation": { "properties": { "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation" }, "CheckOnboardingStatusResponse": { "id": "CheckOnboardingStatusResponse", "description": "Response message for `CheckOnboardingStatus` method.", "type": "object", "properties": { "serviceAccount": { "description": "The service account that PAM uses to act on this resource.", "type": "string" }, "findings": { "description": "List of issues that are preventing PAM from functioning for this resource and need to be fixed to complete onboarding. Some issues might not be detected or reported.", "type": "array", "items": { "$ref": "Finding" } } } }, "Step": { "properties": { "approvalsNeeded": { "format": "int32", "description": "Required. How many users from the above list need to approve. If there aren't enough distinct users in the list, then the workflow indefinitely blocks. Should always be greater than 0. 1 is the only supported value.", "type": "integer" }, "approverEmailRecipients": { "description": "Optional. Additional email addresses to be notified when a grant is pending approval.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Output only. Step ID used to identify the step in the workflow.", "type": "string", "readOnly": true }, "approvers": { "description": "Optional. The potential set of approvers in this step. This list must contain at most one entry.", "type": "array", "items": { "$ref": "AccessControlEntry" } } }, "description": "Step represents a logical step in a manual approval workflow.", "type": "object", "id": "Step" }, "Approved": { "id": "Approved", "description": "An event representing that the grant was approved.", "type": "object", "properties": { "actor": { "description": "Output only. Username of the user who approved the grant.", "type": "string", "readOnly": true }, "stepId": { "description": "Output only. The ID of the approval workflow step that was approved.", "type": "string", "readOnly": true }, "reason": { "description": "Output only. The reason provided by the approver for approving the grant.", "type": "string", "readOnly": true } } }, "Denied": { "properties": { "stepId": { "readOnly": true, "description": "Output only. The ID of the approval workflow step that was denied.", "type": "string" }, "reason": { "description": "Output only. The reason provided by the approver for denying the grant.", "type": "string", "readOnly": true }, "actor": { "readOnly": true, "description": "Output only. Username of the user who denied the grant.", "type": "string" } }, "description": "An event representing that the grant was denied.", "type": "object", "id": "Denied" }, "OperationMetadata": { "properties": { "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true }, "target": { "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string" }, "statusMessage": { "readOnly": true, "description": "Output only. Human-readable status of the operation, if any.", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "requestedCancellation": { "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" }, "apiVersion": { "readOnly": true, "description": "Output only. API version used to start the operation.", "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "description": "Represents the metadata of the long-running operation.", "type": "object", "id": "OperationMetadata" }, "ListOperationsResponse": { "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array" }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } } }, "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "SearchEntitlementsResponse": { "properties": { "entitlements": { "items": { "$ref": "Entitlement" }, "description": "The list of entitlements.", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "description": "Response message for `SearchEntitlements` method.", "type": "object", "id": "SearchEntitlementsResponse" }, "FetchEffectiveSettingsResponse_EmailNotificationSettings": { "id": "FetchEffectiveSettingsResponse_EmailNotificationSettings", "description": "`EmailNotificationSettings` reflects the effective node-wide email notification settings.", "type": "object", "properties": { "customNotificationBehavior": { "description": "Output only. Granular settings of notifications.", "$ref": "FetchEffectiveSettingsResponseEmailNotificationSettings_CustomNotificationBehavior", "readOnly": true }, "disableAllNotifications": { "readOnly": true, "description": "Output only. Disable all notifications.", "$ref": "FetchEffectiveSettingsResponseEmailNotificationSettings_DisableAllNotifications" }, "source": { "readOnly": true, "description": "Output only. The name of the resource from which the notification behavior is inherited. This field remains empty if the setting is not defined at either the parent or resource level, in which case PAM's default behavior is applied.", "type": "string" } } }, "PrivilegedAccess": { "properties": { "gcpIamAccess": { "description": "Access to a Google Cloud resource through IAM.", "$ref": "GcpIamAccess" } }, "id": "PrivilegedAccess", "description": "Privileged access that this service can be used to gate.", "type": "object" }, "Entitlement": { "properties": { "updateTime": { "description": "Output only. Update time stamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "state": { "enumDescriptions": [ "Unspecified state. This value is never returned by the server.", "The entitlement is being created.", "The entitlement is available for requesting access.", "The entitlement is being deleted.", "The entitlement has been deleted.", "The entitlement is being updated." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "AVAILABLE", "DELETING", "DELETED", "UPDATING" ], "readOnly": true, "description": "Output only. Current state of this entitlement.", "type": "string" }, "approvalWorkflow": { "description": "Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.", "$ref": "ApprovalWorkflow" }, "maxRequestDuration": { "format": "google-duration", "description": "Required. The maximum amount of time that access is granted for a request. A requester can ask for a shorter duration but never a longer one. The supported range is between 30 minutes and 168 hours (7 days).", "type": "string" }, "etag": { "description": "An `etag` is used for optimistic concurrency control as a way to prevent simultaneous updates to the same entitlement. An `etag` is returned in the response to `GetEntitlement` and the caller should put the `etag` in the request to `UpdateEntitlement` so that their change is applied on the same version. If this field is omitted or if there is a mismatch while updating an entitlement, then the server rejects the request.", "type": "string" }, "requesterJustificationConfig": { "description": "Required. The manner in which the requester should provide a justification for requesting access.", "$ref": "RequesterJustificationConfig" }, "privilegedAccess": { "description": "Optional. The access granted to a requester on successful approval.", "$ref": "PrivilegedAccess" }, "createTime": { "description": "Output only. Create time stamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "additionalNotificationTargets": { "description": "Optional. Additional email addresses to be notified based on actions taken.", "$ref": "AdditionalNotificationTargets" }, "name": { "description": "Identifier. Name of the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}`", "type": "string" }, "eligibleUsers": { "items": { "$ref": "AccessControlEntry" }, "description": "Optional. Who can create grants using this entitlement. This list should contain at most one entry.", "type": "array" } }, "description": "An entitlement defines the eligibility of a set of users to obtain predefined access for some time possibly after going through an approval workflow.", "type": "object", "id": "Entitlement" }, "Scheduled": { "properties": { "scheduledActivationTime": { "description": "Output only. The time at which the access is granted.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "description": "An event representing that the grant has been scheduled to be activated later.", "type": "object", "id": "Scheduled" }, "IAMAccessDenied": { "id": "IAMAccessDenied", "description": "PAM's service account is being denied access by Cloud IAM. This can be fixed by granting a role that contains the missing permissions to the service account or exempting it from deny policies if they are blocking the access.", "type": "object", "properties": { "missingPermissions": { "items": { "type": "string" }, "description": "List of permissions that are being denied.", "type": "array" } } }, "AuditTrail": { "properties": { "accessGrantTime": { "description": "Output only. The time at which access was given.", "type": "string", "readOnly": true, "format": "google-datetime" }, "accessRemoveTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the system removed access. This could be because of an automatic expiry or because of a revocation. If unspecified, then access hasn't been removed yet.", "type": "string" } }, "description": "Audit trail for the access provided by this grant.", "type": "object", "id": "AuditTrail" }, "Settings": { "description": "`Settings` resource defines the properties, applied directly to the resource or inherited through the hierarchy, to enable consistent, federated use of PAM. The behavior is as follows: 1. If explicitly set to empty at the node level, PAM's default settings are applied for that node. 2. If not set at the node level, settings are inherited from the closest ancestor with a non-empty value. If none of the ancestors has the field set, PAM's default settings are applied. 3. If explicitly set to a non-empty value at the node level, the specified settings are applied for that node.", "type": "object", "id": "Settings", "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Update timestamp.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create timestamp.", "type": "string" }, "name": { "description": "Identifier. Name of the settings resource. Possible formats: projects/{project-id|project-number}/locations/{location}/settings folders/{folder-number}/locations/{location}/settings organizations/{organization-number}/locations/{location}/settings", "type": "string" }, "etag": { "description": "Fingerprint for optimistic concurrency returned in the response of `GetSettings`. Must be provided in the requests to `UpdateSettings`. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.", "type": "string" }, "serviceAccountApproverSettings": { "description": "Optional. This controls the node-level settings for allowing service accounts as approvers.", "$ref": "Settings_ServiceAccountApproverSettings" }, "emailNotificationSettings": { "description": "Optional. `EmailNotificationSettings` defines node-wide email notification preferences for various PAM events.", "$ref": "Settings_EmailNotificationSettings" } } }, "Settings_ServiceAccountApproverSettings": { "properties": { "enabled": { "description": "Optional. Indicates whether service account is allowed to grant approvals.", "type": "boolean" } }, "description": "This controls whether service accounts are allowed to approve grants or can be designated as approvers within PAM entitlements.", "type": "object", "id": "Settings_ServiceAccountApproverSettings" }, "RequestedPrivilegedAccess": { "properties": { "gcpIamAccess": { "description": "Access to a Google Cloud resource through IAM.", "$ref": "RequestedPrivilegedAccess_GcpIamAccess" } }, "id": "RequestedPrivilegedAccess", "description": "Privileged access that is requested by a user via a grant.", "type": "object" }, "FetchEffectiveSettingsResponse": { "properties": { "parent": { "description": "Output only. The resource on which the settings are effective. Possible formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "type": "string", "readOnly": true }, "serviceAccountApproverSettings": { "readOnly": true, "description": "Output only. Effective settings for allowing service account as approvers.", "$ref": "FetchEffectiveSettingsResponse_ServiceAccountApproverSettings" }, "emailNotificationSettings": { "description": "Output only. `EmailNotificationSettings` defines effective node-wide email notification preferences for various PAM events.", "$ref": "FetchEffectiveSettingsResponse_EmailNotificationSettings", "readOnly": true } }, "description": "The effective value of the settings at the given location resource, evaluated based on the crm resource hierarchy.", "type": "object", "id": "FetchEffectiveSettingsResponse" }, "RequesterJustificationConfig": { "id": "RequesterJustificationConfig", "description": "Defines how a requester must provide a justification when requesting access.", "type": "object", "properties": { "notMandatory": { "description": "This option means the requester isn't required to provide a justification.", "$ref": "NotMandatory" }, "unstructured": { "description": "This option means the requester must provide a string as justification. If this is selected, the server allows the requester to provide a justification but doesn't validate it.", "$ref": "Unstructured" } } }, "RoleBinding": { "id": "RoleBinding", "description": "IAM role bindings that are created after a successful grant.", "type": "object", "properties": { "role": { "description": "Required. IAM role to be granted. https://cloud.google.com/iam/docs/roles-overview.", "type": "string" }, "conditionExpression": { "description": "Optional. The expression field of the IAM condition to be associated with the role. If specified, a user with an active grant for this entitlement is able to access the resource only if this condition evaluates to true for their request. This field uses the same CEL format as IAM and supports all attributes that IAM supports, except tags. https://cloud.google.com/iam/docs/conditions-overview#attributes.", "type": "string" }, "id": { "readOnly": true, "description": "Output only. The ID corresponding to this role binding in the policy binding. This will be unique within an entitlement across time. Gets re-generated each time the entitlement is updated.", "type": "string" } } }, "Activated": { "description": "An event representing that the grant was successfully activated.", "type": "object", "id": "Activated", "properties": {} }, "RequestedPrivilegedAccessGcpIamAccess_RoleBinding": { "properties": { "entitlementRoleBindingId": { "description": "Required. The role binding id of the role to be granted from the entitlement.", "type": "string" }, "accessRestrictions": { "description": "Optional. The access restrictions to be applied to the role binding. This further restricts the access of this role binding to specific resources.", "$ref": "RequestedPrivilegedAccessGcpIamAccess_AccessRestrictions" }, "role": { "readOnly": true, "description": "Output only. The IAM role requested as part of the grant.", "type": "string" }, "entitlementConditionExpression": { "readOnly": true, "description": "Output only. The IAM condition expression associated with the role at the time of grant request.", "type": "string" } }, "id": "RequestedPrivilegedAccessGcpIamAccess_RoleBinding", "description": "IAM role bindings that are requested as part of the grant.", "type": "object" }, "Unstructured": { "properties": {}, "description": "The requester has to provide a justification in the form of a string.", "type": "object", "id": "Unstructured" }, "ListLocationsResponse": { "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } } }, "description": "The response message for Locations.ListLocations.", "type": "object", "id": "ListLocationsResponse" }, "SettingsEmailNotificationSettingsCustomNotificationBehavior_RequesterNotifications": { "description": "Email notifications specific to Requesters.", "type": "object", "id": "SettingsEmailNotificationSettingsCustomNotificationBehavior_RequesterNotifications", "properties": { "grantEnded": { "description": "Optional. Notification mode for grant ended.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantActivated": { "description": "Optional. Notification mode for grant activated.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantActivationScheduled": { "description": "Optional. Notification mode for grant activation scheduled.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "entitlementAssigned": { "description": "Optional. Notification mode for entitlement assigned.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantRevoked": { "description": "Optional. Notification mode for grant revoked.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantExternallyModified": { "description": "Optional. Notification mode for grant externally modified.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantDenied": { "description": "Optional. Notification mode for grant denied.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantExpired": { "description": "Optional. Notification mode for grant request expired.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantActivationFailed": { "description": "Optional. Notification mode for grant activation failed.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] } } }, "Grant": { "properties": { "requestedPrivilegedAccess": { "items": { "$ref": "RequestedPrivilegedAccess" }, "description": "Optional. The accesses requested to be granted by this grant.", "type": "array" }, "auditTrail": { "readOnly": true, "description": "Output only. Audit trail of access provided by this grant. If unspecified then access was never granted.", "$ref": "AuditTrail" }, "requestedDuration": { "description": "Required. The amount of time access is needed for. This value should be shorter than the `max_request_duration` value of the entitlement.", "type": "string", "format": "google-duration" }, "externallyModified": { "readOnly": true, "description": "Output only. Flag set by the PAM system to indicate that policy bindings made by this grant have been modified from outside PAM. After it is set, this flag remains set forever irrespective of the grant state. A `true` value here indicates that PAM no longer has any certainty on the access a user has because of this grant.", "type": "boolean" }, "privilegedAccess": { "readOnly": true, "description": "Output only. The access that would be granted by this grant.", "$ref": "PrivilegedAccess" }, "justification": { "description": "Optional. Justification of why this access is needed.", "$ref": "Justification" }, "createTime": { "description": "Output only. Create time stamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "name": { "description": "Identifier. Name of this grant. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}` The last segment of this name (`{grant-id}`) is autogenerated.", "type": "string" }, "timeline": { "description": "Output only. Timeline of this grant.", "$ref": "Timeline", "readOnly": true }, "additionalEmailRecipients": { "items": { "type": "string" }, "description": "Optional. Additional email addresses to notify for all the actions performed on the grant.", "type": "array" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Update time stamp.", "type": "string" }, "state": { "enumDescriptions": [ "Unspecified state. This value is never returned by the server.", "The entitlement had an approval workflow configured and this grant is waiting for the workflow to complete.", "The approval workflow completed with a denied result. No access is granted for this grant. This is a terminal state.", "The approval workflow completed successfully with an approved result or none was configured. Access is provided at an appropriate time.", "Access is being given.", "Access was successfully given and is currently active.", "The system could not give access due to a non-retriable error. This is a terminal state.", "Expired after waiting for the approval workflow to complete. This is a terminal state.", "Access is being revoked.", "Access was revoked by a user. This is a terminal state.", "System took back access as the requested duration was over. This is a terminal state.", "Access is being withdrawn.", "Grant was withdrawn by the grant owner. This is a terminal state." ], "enum": [ "STATE_UNSPECIFIED", "APPROVAL_AWAITED", "DENIED", "SCHEDULED", "ACTIVATING", "ACTIVE", "ACTIVATION_FAILED", "EXPIRED", "REVOKING", "REVOKED", "ENDED", "WITHDRAWING", "WITHDRAWN" ], "readOnly": true, "description": "Output only. Current state of this grant.", "type": "string" }, "requester": { "readOnly": true, "description": "Output only. Username of the user who created this grant.", "type": "string" }, "activationTrigger": { "description": "Optional. The activation trigger for this grant. This field being absent indicates default behavior for the grant, that is, the grant will get activated as soon as the required number of approvals are received or, if approvals are not required, as soon as the grant is created.", "$ref": "ActivationTrigger" } }, "id": "Grant", "description": "A grant represents a request from a user for obtaining the access specified in an entitlement they are eligible for.", "type": "object" }, "Status": { "properties": { "details": { "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "id": "Status" }, "FetchEffectiveSettingsResponseEmailNotificationSettings_CustomNotificationBehavior": { "description": "`CustomNotificationBehavior` reflects the granular notification delivery settings for specific events and personas, as configured by the admin.", "type": "object", "id": "FetchEffectiveSettingsResponseEmailNotificationSettings_CustomNotificationBehavior", "properties": { "approverNotifications": { "readOnly": true, "description": "Output only. Approver email notifications.", "$ref": "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_ApproverNotifications" }, "adminNotifications": { "description": "Output only. Admin email notifications.", "$ref": "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_AdminNotifications", "readOnly": true }, "requesterNotifications": { "readOnly": true, "description": "Output only. Requester email notifications.", "$ref": "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_RequesterNotifications" } } }, "ActivationTrigger": { "id": "ActivationTrigger", "description": "ActivationTrigger represents the different possible activation triggers for the grant.", "type": "object", "properties": { "requestedActivationTime": { "format": "google-datetime", "description": "A specific time at which the access should be granted.", "type": "string" } } }, "GoogleProtobufEmpty": { "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "id": "GoogleProtobufEmpty" }, "GcpIamAccess": { "id": "GcpIamAccess", "description": "`GcpIamAccess` represents IAM based access control on a Google Cloud resource. Refer to https://cloud.google.com/iam/docs to understand more about IAM.", "type": "object", "properties": { "roleBindings": { "description": "Required. Role bindings that are created on successful grant.", "type": "array", "items": { "$ref": "RoleBinding" } }, "resourceType": { "description": "Required. The type of this resource.", "type": "string" }, "resource": { "description": "Required. Name of the resource.", "type": "string" } } }, "Revoked": { "properties": { "reason": { "readOnly": true, "description": "Output only. The reason provided by the user for revoking the grant.", "type": "string" }, "actor": { "description": "Output only. Username of the user who revoked the grant.", "type": "string", "readOnly": true } }, "id": "Revoked", "description": "An event representing that the grant was revoked.", "type": "object" }, "SettingsEmailNotificationSettingsCustomNotificationBehavior_AdminNotifications": { "properties": { "grantEnded": { "description": "Optional. Notification mode for grant ended.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantActivationFailed": { "description": "Optional. Notification mode for grant activation failed.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantExternallyModified": { "description": "Optional. Notification mode for grant externally modified.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantActivated": { "description": "Optional. Notification mode for grant activated.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "grantActivationScheduled": { "description": "Optional. Notification mode for grant activation scheduled.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] } }, "id": "SettingsEmailNotificationSettingsCustomNotificationBehavior_AdminNotifications", "description": "Email notifications specific to Admins.", "type": "object" }, "ApproveGrantRequest": { "properties": { "reason": { "description": "Optional. The reason for approving this grant. This is required if the `require_approver_justification` field of the `ManualApprovals` workflow used in this grant is true.", "type": "string" } }, "description": "Request message for `ApproveGrant` method.", "type": "object", "id": "ApproveGrantRequest" }, "ActivationFailed": { "properties": { "error": { "description": "Output only. The error that occurred while activating the grant.", "$ref": "Status", "readOnly": true } }, "id": "ActivationFailed", "description": "An event representing that the grant activation failed.", "type": "object" }, "Event": { "properties": { "revoked": { "description": "The grant was revoked.", "$ref": "Revoked" }, "scheduled": { "description": "The grant has been scheduled to give access.", "$ref": "Scheduled" }, "ended": { "description": "Access given by the grant ended automatically as the approved duration was over.", "$ref": "Ended" }, "externallyModified": { "description": "The policy bindings made by grant have been modified outside of PAM.", "$ref": "ExternallyModified" }, "activated": { "description": "The grant was successfully activated to give access.", "$ref": "Activated" }, "expired": { "description": "The approval workflow did not complete in the necessary duration, and so the grant is expired.", "$ref": "Expired" }, "requested": { "description": "The grant was requested.", "$ref": "Requested" }, "denied": { "description": "The grant was denied.", "$ref": "Denied" }, "approved": { "description": "The grant was approved.", "$ref": "Approved" }, "withdrawn": { "description": "The grant was withdrawn.", "$ref": "Withdrawn" }, "activationFailed": { "description": "There was a non-retriable error while trying to give access.", "$ref": "ActivationFailed" }, "eventTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time (as recorded at server) when this event occurred.", "type": "string" } }, "description": "A single operation on the grant.", "type": "object", "id": "Event" }, "SettingsEmailNotificationSettings_DisableAllNotifications": { "description": "This option indicates that all email notifications are disabled.", "type": "object", "id": "SettingsEmailNotificationSettings_DisableAllNotifications", "properties": {} }, "RequestedPrivilegedAccessGcpIamAccess_AccessRestrictions": { "properties": { "resourceNames": { "items": { "type": "string" }, "description": "Optional. The resource names to restrict the access to. Follow https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-name format.", "type": "array" }, "resourceNamePrefixes": { "items": { "type": "string" }, "description": "Optional. The resource name prefixes to restrict the access to. Follow https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-name format.", "type": "array" } }, "description": "AccessRestrictions represents a set of resources to further restrict the access to. This is used to get finer grained access as part of a grant. All restrictions are OR-ed with each other.", "type": "object", "id": "RequestedPrivilegedAccessGcpIamAccess_AccessRestrictions" }, "Finding": { "properties": { "iamAccessDenied": { "description": "PAM's service account is being denied access by Cloud IAM.", "$ref": "IAMAccessDenied" } }, "description": "Finding represents an issue which prevents PAM from functioning properly for this resource.", "type": "object", "id": "Finding" }, "Settings_EmailNotificationSettings": { "description": "`EmailNotificationSettings` defines the node-wide email notification settings.", "type": "object", "id": "Settings_EmailNotificationSettings", "properties": { "disableAllNotifications": { "description": "Disable all notifications.", "$ref": "SettingsEmailNotificationSettings_DisableAllNotifications" }, "customNotificationBehavior": { "description": "Granular settings of notifications.", "$ref": "SettingsEmailNotificationSettings_CustomNotificationBehavior" } } }, "SettingsEmailNotificationSettingsCustomNotificationBehavior_ApproverNotifications": { "properties": { "pendingApproval": { "description": "Optional. Notification mode for pending approval.", "type": "string", "enumDescriptions": [ "Default notification behavior following PAM's standard settings.", "Notifications are enabled.", "Notifications are disabled." ], "enum": [ "NOTIFICATION_MODE_UNSPECIFIED", "ENABLED", "DISABLED" ] } }, "description": "Email notifications specific to Approvers.", "type": "object", "id": "SettingsEmailNotificationSettingsCustomNotificationBehavior_ApproverNotifications" }, "FetchEffectiveSettingsResponseEmailNotificationSettings_DisableAllNotifications": { "description": "This option indicates that all email notifications are disabled.", "type": "object", "id": "FetchEffectiveSettingsResponseEmailNotificationSettings_DisableAllNotifications", "properties": {} }, "Timeline": { "properties": { "events": { "readOnly": true, "items": { "$ref": "Event" }, "description": "Output only. The events that have occurred on this grant. This list contains entries in the same order as they occurred. The first entry is always be of type `Requested` and there is always at least one entry in this array.", "type": "array" } }, "id": "Timeline", "description": "Timeline of a grant describing what happened to it and when.", "type": "object" }, "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_ApproverNotifications": { "properties": { "notifyPendingApproval": { "readOnly": true, "description": "Output only. Notification delivery for pending approval.", "type": "boolean" } }, "id": "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_ApproverNotifications", "description": "Email notifications specific to Approvers.", "type": "object" }, "RequestedPrivilegedAccess_GcpIamAccess": { "id": "RequestedPrivilegedAccess_GcpIamAccess", "description": "`GcpIamAccess` represents IAM based access control on a Google Cloud resource. Refer to https://cloud.google.com/iam/docs to understand more about IAM.", "type": "object", "properties": { "resource": { "description": "Required. Name of the resource.", "type": "string" }, "resourceType": { "description": "Required. The type of this resource.", "type": "string" }, "roleBindings": { "items": { "$ref": "RequestedPrivilegedAccessGcpIamAccess_RoleBinding" }, "description": "Optional. Role bindings that are requested as part of the grant.", "type": "array" } } }, "RevokeGrantRequest": { "properties": { "reason": { "description": "Optional. The reason for revoking this grant.", "type": "string" } }, "id": "RevokeGrantRequest", "description": "Request message for `RevokeGrant` method.", "type": "object" }, "Location": { "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } } }, "description": "A resource that represents a Google Cloud location.", "type": "object", "id": "Location" }, "ListGrantsResponse": { "description": "Message for response to listing grants.", "type": "object", "id": "ListGrantsResponse", "properties": { "grants": { "description": "The list of grants.", "type": "array", "items": { "$ref": "Grant" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "Justification": { "properties": { "unstructuredJustification": { "description": "A free form textual justification. The system only ensures that this is not empty. No other kind of validation is performed on the string.", "type": "string" } }, "id": "Justification", "description": "Justification represents a justification for requesting access.", "type": "object" }, "Requested": { "description": "An event representing that a grant was requested.", "type": "object", "id": "Requested", "properties": { "expireTime": { "description": "Output only. The time at which this grant expires unless the approval workflow completes. If omitted, then the request never expires.", "type": "string", "readOnly": true, "format": "google-datetime" } } }, "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_AdminNotifications": { "properties": { "notifyGrantActivated": { "description": "Output only. Notification delivery for grant activated.", "type": "boolean", "readOnly": true }, "notifyGrantExternallyModified": { "readOnly": true, "description": "Output only. Notification delivery for grant externally modified.", "type": "boolean" }, "notifyGrantActivationScheduled": { "description": "Output only. Notification delivery for grant activation scheduled.", "type": "boolean", "readOnly": true }, "notifyGrantEnded": { "description": "Output only. Notification delivery for grant ended.", "type": "boolean", "readOnly": true }, "notifyGrantActivationFailed": { "description": "Output only. Notification delivery for grant activation failed.", "type": "boolean", "readOnly": true } }, "description": "Email notifications specific to Admins.", "type": "object", "id": "FetchEffectiveSettingsResponseEmailNotificationSettingsCustomNotificationBehavior_AdminNotifications" }, "ListEntitlementsResponse": { "properties": { "entitlements": { "items": { "$ref": "Entitlement" }, "description": "The list of entitlements.", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "id": "ListEntitlementsResponse", "description": "Message for response to listing entitlements.", "type": "object" }, "ApprovalWorkflow": { "description": "Different types of approval workflows that can be used to gate privileged access granting.", "type": "object", "id": "ApprovalWorkflow", "properties": { "manualApprovals": { "description": "An approval workflow where users designated as approvers review and act on the grants.", "$ref": "ManualApprovals" } } }, "AdditionalNotificationTargets": { "description": "`AdditionalNotificationTargets` includes email addresses to be notified.", "type": "object", "id": "AdditionalNotificationTargets", "properties": { "adminEmailRecipients": { "items": { "type": "string" }, "description": "Optional. Additional email addresses to be notified when a principal (requester) is granted access.", "type": "array" }, "requesterEmailRecipients": { "items": { "type": "string" }, "description": "Optional. Additional email address to be notified about an eligible entitlement.", "type": "array" } } }, "WithdrawGrantRequest": { "properties": {}, "description": "Request message for `WithdrawGrant` method.", "type": "object", "id": "WithdrawGrantRequest" }, "AccessControlEntry": { "description": "`AccessControlEntry` is used to control who can do some operation.", "type": "object", "id": "AccessControlEntry", "properties": { "principals": { "items": { "type": "string" }, "description": "Optional. Users who are allowed for the operation. Each entry should be a valid v1 IAM principal identifier. The format for these is documented at: https://cloud.google.com/iam/docs/principal-identifiers#v1", "type": "array" } } }, "Expired": { "id": "Expired", "description": "An event representing that the grant was expired.", "type": "object", "properties": {} }, "Withdrawn": { "properties": {}, "id": "Withdrawn", "description": "An event representing that the grant was withdrawn.", "type": "object" }, "DenyGrantRequest": { "properties": { "reason": { "description": "Optional. The reason for denying this grant. This is required if `require_approver_justification` field of the `ManualApprovals` workflow used in this grant is true.", "type": "string" } }, "description": "Request message for `DenyGrant` method.", "type": "object", "id": "DenyGrantRequest" } }, "version_module": true, "parameters": { "alt": { "default": "json", "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "quotaUser": { "location": "query", "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "prettyPrint": { "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." } }, "id": "privilegedaccessmanager:v1beta", "name": "privilegedaccessmanager", "fullyEncodeReservedExpansion": true, "version": "v1beta", "ownerDomain": "google.com", "batchPath": "batch", "mtlsRootUrl": "https://privilegedaccessmanager.mtls.googleapis.com/", "description": "Privileged Access Manager (PAM) helps you to follow least privilege best practice to mitigate risks tied to privileged access misuse and abuse. You can shift from always-on standing privileges to on-demand access using time-bound and approval-based access elevations. IAM administrators specifically can use PAM to create entitlements that can grant temporary access to a specific resource scope. Requesters can explore eligible entitlements and request the access needed for their task, and approvers are notified when approvals require their attention. Streamlined workflows facilitated using PAM support several use cases, including the following: * Emergency access for incident responders * Time-boxed access for developers for critical deployment or maintenance * Temporary access for operators for data ingestion and audits * Temporary access to service accounts for automated tasks ", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "resources": { "projects": { "resources": { "locations": { "methods": { "get": { "description": "Gets information about a location.", "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "parameters": { "name": { "description": "Resource name for the location.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "httpMethod": "GET", "id": "privilegedaccessmanager.projects.locations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getSettings": { "description": "`GetSettings` returns the PAM Settings for the given project, folder, or organization.", "parameters": { "name": { "description": "Required. The name of the settings resource to be fetched.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "path": "v1beta/{+name}", "id": "privilegedaccessmanager.projects.locations.getSettings", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/settings" }, "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "parameters": { "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "extraLocationTypes": { "location": "query", "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string" }, "name": { "description": "The resource that owns the locations collection, if applicable.", "type": "string", "pattern": "^projects/[^/]+$", "location": "path", "required": true }, "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "path": "v1beta/{+name}/locations", "httpMethod": "GET", "id": "privilegedaccessmanager.projects.locations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations" }, "updateSettings": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Identifier. Name of the settings resource. Possible formats: projects/{project-id|project-number}/locations/{location}/settings folders/{folder-number}/locations/{location}/settings organizations/{organization-number}/locations/{location}/settings", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. A value of '*' for this field refers to full replacement of the resource.", "type": "string" } }, "request": { "$ref": "Settings" }, "description": "`UpdateSettings` updates the PAM Settings resource specified in the request. Updated fields in the settings need to be specified in an update mask. The following fields are not supported for updates: * Settings name * Create time * Update time * Etag", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/settings", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "id": "privilegedaccessmanager.projects.locations.updateSettings", "path": "v1beta/{+name}" }, "fetchEffectiveSettings": { "id": "privilegedaccessmanager.projects.locations.fetchEffectiveSettings", "httpMethod": "GET", "path": "v1beta/{+parent}:fetchEffectiveSettings", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:fetchEffectiveSettings", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`FetchEffectiveSettings` returns the effective PAM Settings for the given project, folder, or organization.", "parameterOrder": [ "parent" ], "response": { "$ref": "FetchEffectiveSettingsResponse" }, "parameters": { "parent": { "description": "Required. The resource for which the effective settings is fetched, in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } } }, "checkOnboardingStatus": { "path": "v1beta/{+parent}:checkOnboardingStatus", "id": "privilegedaccessmanager.projects.locations.checkOnboardingStatus", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:checkOnboardingStatus", "description": "`CheckOnboardingStatus` reports the onboarding status for a project, folder, or organization. Any findings reported by this API need to be fixed before PAM can be used on the resource.", "parameters": { "parent": { "description": "Required. The resource for which the onboarding status should be checked. Should be in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "CheckOnboardingStatusResponse" } } }, "resources": { "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "The name of the operation resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "httpMethod": "GET", "id": "privilegedaccessmanager.projects.locations.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1beta/{+name}", "id": "privilegedaccessmanager.projects.locations.operations.delete", "httpMethod": "DELETE" }, "list": { "id": "privilegedaccessmanager.projects.locations.operations.list", "httpMethod": "GET", "path": "v1beta/{+name}/operations", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation's parent resource.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } } } } }, "entitlements": { "resources": { "grants": { "methods": { "list": { "path": "v1beta/{+parent}/grants", "httpMethod": "GET", "id": "privilegedaccessmanager.projects.locations.entitlements.grants.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "description": "Lists grants for a given entitlement.", "parameters": { "filter": { "location": "query", "description": "Optional. Filtering results.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource which owns the grants.", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer", "format": "int32", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGrantsResponse" } }, "revoke": { "request": { "$ref": "RevokeGrantRequest" }, "description": "`RevokeGrant` is used to immediately revoke access for a grant. This method can be called when the grant is in a non-terminal state.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the grant resource which is being revoked.", "type": "string" } }, "httpMethod": "POST", "id": "privilegedaccessmanager.projects.locations.entitlements.grants.revoke", "path": "v1beta/{+name}:revoke", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:revoke", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "withdraw": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the grant resource which is being withdrawn.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "WithdrawGrantRequest" }, "description": "`WithdrawGrant` is used to immediately withdraw the grant. This method can be called when the grant is in a non-terminal state.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:withdraw", "path": "v1beta/{+name}:withdraw", "id": "privilegedaccessmanager.projects.locations.entitlements.grants.withdraw", "httpMethod": "POST" }, "search": { "description": "`SearchGrants` returns grants that are related to the calling user in the specified way.", "parameterOrder": [ "parent" ], "response": { "$ref": "SearchGrantsResponse" }, "parameters": { "callerRelationship": { "description": "Required. Only grants which the caller is related to by this relationship are returned in the response.", "type": "string", "enumDescriptions": [ "Unspecified caller relationship type.", "The user created this grant by calling `CreateGrant` earlier.", "The user is an approver for the entitlement that this grant is parented under and can currently approve/deny it.", "The caller had successfully approved/denied this grant earlier." ], "enum": [ "CALLER_RELATIONSHIP_TYPE_UNSPECIFIED", "HAD_CREATED", "CAN_APPROVE", "HAD_APPROVED" ], "location": "query" }, "filter": { "location": "query", "description": "Optional. Only grants matching this filter are returned in the response.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "description": "Required. The parent which owns the grant resources.", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, server picks an appropriate default.", "type": "integer", "location": "query" } }, "httpMethod": "GET", "id": "privilegedaccessmanager.projects.locations.entitlements.grants.search", "path": "v1beta/{+parent}/grants:search", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "Grant" }, "parameters": { "requestId": { "description": "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. This prevents clients from accidentally creating duplicate grants. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the parent entitlement for which this grant is being requested.", "type": "string" } }, "request": { "$ref": "Grant" }, "description": "Creates a grant in a given project, folder, or organization and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "privilegedaccessmanager.projects.locations.entitlements.grants.create", "httpMethod": "POST", "path": "v1beta/{+parent}/grants" }, "deny": { "parameters": { "name": { "description": "Required. Name of the grant resource which is being denied.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "request": { "$ref": "DenyGrantRequest" }, "description": "`DenyGrant` is used to deny a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:deny", "path": "v1beta/{+name}:deny", "id": "privilegedaccessmanager.projects.locations.entitlements.grants.deny", "httpMethod": "POST" }, "get": { "path": "v1beta/{+name}", "id": "privilegedaccessmanager.projects.locations.entitlements.grants.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}", "description": "Get details of a single grant.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the resource.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Grant" } }, "approve": { "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "description": "Required. Name of the grant resource which is being approved.", "type": "string" } }, "request": { "$ref": "ApproveGrantRequest" }, "description": "`ApproveGrant` is used to approve a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:approve", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "privilegedaccessmanager.projects.locations.entitlements.grants.approve", "httpMethod": "POST", "path": "v1beta/{+name}:approve" } } } }, "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}", "path": "v1beta/{+name}", "httpMethod": "PATCH", "id": "privilegedaccessmanager.projects.locations.entitlements.patch", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "description": "Identifier. Name of the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}`", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`) A value of '*' for this field refers to full replacement of the resource.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "Entitlement" }, "description": "Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants. The following fields are not supported for updates: * All immutable fields * Entitlement name * Resource name * Resource type * Adding an approval workflow in an entitlement which previously had no approval workflow. * Deleting the approval workflow from an entitlement. * Adding or deleting a step in the approval workflow (only one step is supported) Note that updates are allowed on the list of approvers in an approval workflow step." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements", "path": "v1beta/{+parent}/entitlements", "httpMethod": "GET", "id": "privilegedaccessmanager.projects.locations.entitlements.list", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent which owns the entitlement resources.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "filter": { "description": "Optional. Filtering results.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListEntitlementsResponse" }, "description": "Lists the entitlements in a given project, folder, organization, and in a given location." }, "search": { "description": "`SearchEntitlements` returns entitlements on which the caller has the specified access.", "parameterOrder": [ "parent" ], "response": { "$ref": "SearchEntitlementsResponse" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent which owns the entitlement resources.", "type": "string" }, "filter": { "description": "Optional. Only entitlements matching this filter are returned in the response.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "callerAccessType": { "description": "Required. Only entitlements where the calling user has this access are returned.", "type": "string", "enumDescriptions": [ "Unspecified access type.", "The user has access to create grants using this entitlement.", "The user has access to approve/deny grants created under this entitlement." ], "enum": [ "CALLER_ACCESS_TYPE_UNSPECIFIED", "GRANT_REQUESTER", "GRANT_APPROVER" ], "location": "query" }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" } }, "httpMethod": "GET", "id": "privilegedaccessmanager.projects.locations.entitlements.search", "path": "v1beta/{+parent}/entitlements:search", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "parameters": { "entitlementId": { "description": "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`.", "type": "string", "location": "query" }, "requestId": { "location": "query", "description": "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).", "type": "string" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "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}`", "type": "string" } }, "request": { "$ref": "Entitlement" }, "description": "Creates a new entitlement in a given project, folder, organization, and in a given location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "privilegedaccessmanager.projects.locations.entitlements.create", "httpMethod": "POST", "path": "v1beta/{+parent}/entitlements" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "privilegedaccessmanager.projects.locations.entitlements.delete", "httpMethod": "DELETE", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "requestId": { "location": "query", "description": "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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "force": { "location": "query", "description": "Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)", "type": "boolean" }, "name": { "description": "Required. Name of the resource.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path" } }, "description": "Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement." }, "get": { "path": "v1beta/{+name}", "id": "privilegedaccessmanager.projects.locations.entitlements.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}", "description": "Gets details of a single entitlement.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "description": "Required. Name of the resource.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Entitlement" } } } } } } } }, "organizations": { "resources": { "locations": { "resources": { "operations": { "methods": { "list": { "parameters": { "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "name": { "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation's parent resource.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/operations", "path": "v1beta/{+name}/operations", "id": "privilegedaccessmanager.organizations.locations.operations.list", "httpMethod": "GET" }, "get": { "httpMethod": "GET", "id": "privilegedaccessmanager.organizations.locations.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string" } } }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta/{+name}", "id": "privilegedaccessmanager.organizations.locations.operations.delete", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}" } } }, "entitlements": { "resources": { "grants": { "methods": { "revoke": { "request": { "$ref": "RevokeGrantRequest" }, "description": "`RevokeGrant` is used to immediately revoke access for a grant. This method can be called when the grant is in a non-terminal state.", "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "description": "Required. Name of the grant resource which is being revoked.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta/{+name}:revoke", "httpMethod": "POST", "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.revoke", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:revoke" }, "withdraw": { "request": { "$ref": "WithdrawGrantRequest" }, "description": "`WithdrawGrant` is used to immediately withdraw the grant. This method can be called when the grant is in a non-terminal state.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the grant resource which is being withdrawn.", "type": "string" } }, "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.withdraw", "httpMethod": "POST", "path": "v1beta/{+name}:withdraw", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:withdraw", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1beta/{+parent}/grants", "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "description": "Lists grants for a given entitlement.", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "parent": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "description": "Required. The parent resource which owns the grants.", "type": "string" }, "filter": { "location": "query", "description": "Optional. Filtering results.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGrantsResponse" } }, "get": { "description": "Get details of a single grant.", "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "description": "Required. Name of the resource.", "type": "string" } }, "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.get", "httpMethod": "GET", "path": "v1beta/{+name}", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "search": { "parameterOrder": [ "parent" ], "response": { "$ref": "SearchGrantsResponse" }, "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, server picks an appropriate default.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "parent": { "description": "Required. The parent which owns the grant resources.", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path" }, "callerRelationship": { "description": "Required. Only grants which the caller is related to by this relationship are returned in the response.", "type": "string", "location": "query", "enumDescriptions": [ "Unspecified caller relationship type.", "The user created this grant by calling `CreateGrant` earlier.", "The user is an approver for the entitlement that this grant is parented under and can currently approve/deny it.", "The caller had successfully approved/denied this grant earlier." ], "enum": [ "CALLER_RELATIONSHIP_TYPE_UNSPECIFIED", "HAD_CREATED", "CAN_APPROVE", "HAD_APPROVED" ] }, "filter": { "location": "query", "description": "Optional. Only grants matching this filter are returned in the response.", "type": "string" } }, "description": "`SearchGrants` returns grants that are related to the calling user in the specified way.", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.search", "path": "v1beta/{+parent}/grants:search" }, "create": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.create", "httpMethod": "POST", "path": "v1beta/{+parent}/grants", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Grant" }, "description": "Creates a grant in a given project, folder, or organization and location.", "parameterOrder": [ "parent" ], "response": { "$ref": "Grant" }, "parameters": { "requestId": { "description": "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. This prevents clients from accidentally creating duplicate grants. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string", "location": "query" }, "parent": { "description": "Required. Name of the parent entitlement for which this grant is being requested.", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path" } } }, "deny": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.deny", "httpMethod": "POST", "path": "v1beta/{+name}:deny", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:deny", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "DenyGrantRequest" }, "description": "`DenyGrant` is used to deny a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone.", "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "parameters": { "name": { "description": "Required. Name of the grant resource which is being denied.", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path" } } }, "approve": { "request": { "$ref": "ApproveGrantRequest" }, "description": "`ApproveGrant` is used to approve a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone.", "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "description": "Required. Name of the grant resource which is being approved.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "path": "v1beta/{+name}:approve", "httpMethod": "POST", "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.approve", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:approve" } } } }, "methods": { "search": { "parameterOrder": [ "parent" ], "response": { "$ref": "SearchEntitlementsResponse" }, "parameters": { "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "callerAccessType": { "location": "query", "enumDescriptions": [ "Unspecified access type.", "The user has access to create grants using this entitlement.", "The user has access to approve/deny grants created under this entitlement." ], "enum": [ "CALLER_ACCESS_TYPE_UNSPECIFIED", "GRANT_REQUESTER", "GRANT_APPROVER" ], "description": "Required. Only entitlements where the calling user has this access are returned.", "type": "string" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer", "location": "query" }, "filter": { "description": "Optional. Only entitlements matching this filter are returned in the response.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent which owns the entitlement resources.", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path" } }, "description": "`SearchEntitlements` returns entitlements on which the caller has the specified access.", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "privilegedaccessmanager.organizations.locations.entitlements.search", "httpMethod": "GET", "path": "v1beta/{+parent}/entitlements:search" }, "create": { "path": "v1beta/{+parent}/entitlements", "id": "privilegedaccessmanager.organizations.locations.entitlements.create", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements", "request": { "$ref": "Entitlement" }, "description": "Creates a new entitlement in a given project, folder, organization, and in a given location.", "parameters": { "requestId": { "location": "query", "description": "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).", "type": "string" }, "parent": { "description": "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}`", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path" }, "entitlementId": { "location": "query", "description": "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`.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" } }, "delete": { "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "privilegedaccessmanager.organizations.locations.entitlements.delete", "httpMethod": "DELETE", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Required. Name of the resource.", "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true }, "requestId": { "location": "query", "description": "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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "force": { "description": "Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)", "type": "boolean", "location": "query" } }, "description": "Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement." }, "get": { "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "description": "Required. Name of the resource.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Entitlement" }, "description": "Gets details of a single entitlement.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}", "path": "v1beta/{+name}", "httpMethod": "GET", "id": "privilegedaccessmanager.organizations.locations.entitlements.get" }, "list": { "id": "privilegedaccessmanager.organizations.locations.entitlements.list", "httpMethod": "GET", "path": "v1beta/{+parent}/entitlements", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the entitlements in a given project, folder, organization, and in a given location.", "parameterOrder": [ "parent" ], "response": { "$ref": "ListEntitlementsResponse" }, "parameters": { "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer" }, "filter": { "location": "query", "description": "Optional. Filtering results.", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "type": "string", "location": "query" }, "parent": { "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent which owns the entitlement resources.", "type": "string" } } }, "patch": { "request": { "$ref": "Entitlement" }, "description": "Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants. The following fields are not supported for updates: * All immutable fields * Entitlement name * Resource name * Resource type * Adding an approval workflow in an entitlement which previously had no approval workflow. * Deleting the approval workflow from an entitlement. * Adding or deleting a step in the approval workflow (only one step is supported) Note that updates are allowed on the list of approvers in an approval workflow step.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "description": "Identifier. Name of the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}`", "type": "string" }, "updateMask": { "format": "google-fieldmask", "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`) A value of '*' for this field refers to full replacement of the resource.", "type": "string", "location": "query" } }, "httpMethod": "PATCH", "id": "privilegedaccessmanager.organizations.locations.entitlements.patch", "path": "v1beta/{+name}", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "checkOnboardingStatus": { "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}:checkOnboardingStatus", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "privilegedaccessmanager.organizations.locations.checkOnboardingStatus", "httpMethod": "GET", "path": "v1beta/{+parent}:checkOnboardingStatus", "parameterOrder": [ "parent" ], "response": { "$ref": "CheckOnboardingStatusResponse" }, "parameters": { "parent": { "description": "Required. The resource for which the onboarding status should be checked. Should be in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path" } }, "description": "`CheckOnboardingStatus` reports the onboarding status for a project, folder, or organization. Any findings reported by this API need to be fixed before PAM can be used on the resource." }, "updateSettings": { "request": { "$ref": "Settings" }, "description": "`UpdateSettings` updates the PAM Settings resource specified in the request. Updated fields in the settings need to be specified in an update mask. The following fields are not supported for updates: * Settings name * Create time * Update time * Etag", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Identifier. Name of the settings resource. Possible formats: projects/{project-id|project-number}/locations/{location}/settings folders/{folder-number}/locations/{location}/settings organizations/{organization-number}/locations/{location}/settings", "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/settings$", "location": "path", "required": true }, "updateMask": { "format": "google-fieldmask", "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. A value of '*' for this field refers to full replacement of the resource.", "type": "string", "location": "query" } }, "httpMethod": "PATCH", "id": "privilegedaccessmanager.organizations.locations.updateSettings", "path": "v1beta/{+name}", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/settings", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "fetchEffectiveSettings": { "parameters": { "parent": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource for which the effective settings is fetched, in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "FetchEffectiveSettingsResponse" }, "description": "`FetchEffectiveSettings` returns the effective PAM Settings for the given project, folder, or organization.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}:fetchEffectiveSettings", "path": "v1beta/{+parent}:fetchEffectiveSettings", "id": "privilegedaccessmanager.organizations.locations.fetchEffectiveSettings", "httpMethod": "GET" }, "getSettings": { "path": "v1beta/{+name}", "id": "privilegedaccessmanager.organizations.locations.getSettings", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/settings", "description": "`GetSettings` returns the PAM Settings for the given project, folder, or organization.", "parameters": { "name": { "description": "Required. The name of the settings resource to be fetched.", "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/settings$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" } }, "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "parameters": { "name": { "pattern": "^organizations/[^/]+$", "location": "path", "required": true, "description": "The resource that owns the locations collection, if applicable.", "type": "string" }, "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32", "location": "query" }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "extraLocationTypes": { "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "repeated": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "path": "v1beta/{+name}/locations", "httpMethod": "GET", "id": "privilegedaccessmanager.organizations.locations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}", "path": "v1beta/{+name}", "id": "privilegedaccessmanager.organizations.locations.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Resource name for the location.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "description": "Gets information about a location." } } } } }, "folders": { "resources": { "locations": { "methods": { "updateSettings": { "parameters": { "name": { "description": "Identifier. Name of the settings resource. Possible formats: projects/{project-id|project-number}/locations/{location}/settings folders/{folder-number}/locations/{location}/settings organizations/{organization-number}/locations/{location}/settings", "type": "string", "pattern": "^folders/[^/]+/locations/[^/]+/settings$", "location": "path", "required": true }, "updateMask": { "location": "query", "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. A value of '*' for this field refers to full replacement of the resource.", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "Settings" }, "description": "`UpdateSettings` updates the PAM Settings resource specified in the request. Updated fields in the settings need to be specified in an update mask. The following fields are not supported for updates: * Settings name * Create time * Update time * Etag", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/settings", "path": "v1beta/{+name}", "httpMethod": "PATCH", "id": "privilegedaccessmanager.folders.locations.updateSettings" }, "fetchEffectiveSettings": { "path": "v1beta/{+parent}:fetchEffectiveSettings", "httpMethod": "GET", "id": "privilegedaccessmanager.folders.locations.fetchEffectiveSettings", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}:fetchEffectiveSettings", "description": "`FetchEffectiveSettings` returns the effective PAM Settings for the given project, folder, or organization.", "parameters": { "parent": { "description": "Required. The resource for which the effective settings is fetched, in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "FetchEffectiveSettingsResponse" } }, "checkOnboardingStatus": { "description": "`CheckOnboardingStatus` reports the onboarding status for a project, folder, or organization. Any findings reported by this API need to be fixed before PAM can be used on the resource.", "parameterOrder": [ "parent" ], "response": { "$ref": "CheckOnboardingStatusResponse" }, "parameters": { "parent": { "description": "Required. The resource for which the onboarding status should be checked. Should be in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "type": "string", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "id": "privilegedaccessmanager.folders.locations.checkOnboardingStatus", "httpMethod": "GET", "path": "v1beta/{+parent}:checkOnboardingStatus", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}:checkOnboardingStatus", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "parameters": { "name": { "description": "Resource name for the location.", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path" } }, "description": "Gets information about a location.", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "privilegedaccessmanager.folders.locations.get", "path": "v1beta/{+name}" }, "getSettings": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/settings", "path": "v1beta/{+name}", "id": "privilegedaccessmanager.folders.locations.getSettings", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the settings resource to be fetched.", "type": "string", "pattern": "^folders/[^/]+/locations/[^/]+/settings$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "description": "`GetSettings` returns the PAM Settings for the given project, folder, or organization." }, "list": { "flatPath": "v1beta/folders/{foldersId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "privilegedaccessmanager.folders.locations.list", "path": "v1beta/{+name}/locations", "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "parameters": { "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32", "location": "query" }, "name": { "pattern": "^folders/[^/]+$", "location": "path", "required": true, "description": "The resource that owns the locations collection, if applicable.", "type": "string" }, "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string", "location": "query" }, "extraLocationTypes": { "location": "query", "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string" } }, "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." } }, "resources": { "operations": { "methods": { "list": { "path": "v1beta/{+name}/operations", "httpMethod": "GET", "id": "privilegedaccessmanager.folders.locations.operations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation's parent resource.", "type": "string" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" } }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta/{+name}", "httpMethod": "GET", "id": "privilegedaccessmanager.folders.locations.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}" }, "delete": { "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}", "path": "v1beta/{+name}", "httpMethod": "DELETE", "id": "privilegedaccessmanager.folders.locations.operations.delete" } } }, "entitlements": { "resources": { "grants": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "path": "v1beta/{+parent}/grants", "id": "privilegedaccessmanager.folders.locations.entitlements.grants.list", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent resource which owns the grants.", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path" }, "filter": { "location": "query", "description": "Optional. Filtering results.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGrantsResponse" }, "description": "Lists grants for a given entitlement." }, "revoke": { "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the grant resource which is being revoked.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "RevokeGrantRequest" }, "description": "`RevokeGrant` is used to immediately revoke access for a grant. This method can be called when the grant is in a non-terminal state.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:revoke", "path": "v1beta/{+name}:revoke", "httpMethod": "POST", "id": "privilegedaccessmanager.folders.locations.entitlements.grants.revoke" }, "withdraw": { "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "description": "Required. Name of the grant resource which is being withdrawn.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "WithdrawGrantRequest" }, "description": "`WithdrawGrant` is used to immediately withdraw the grant. This method can be called when the grant is in a non-terminal state.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:withdraw", "path": "v1beta/{+name}:withdraw", "id": "privilegedaccessmanager.folders.locations.entitlements.grants.withdraw", "httpMethod": "POST" }, "search": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants:search", "path": "v1beta/{+parent}/grants:search", "httpMethod": "GET", "id": "privilegedaccessmanager.folders.locations.entitlements.grants.search", "parameters": { "parent": { "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "description": "Required. The parent which owns the grant resources.", "type": "string" }, "callerRelationship": { "enumDescriptions": [ "Unspecified caller relationship type.", "The user created this grant by calling `CreateGrant` earlier.", "The user is an approver for the entitlement that this grant is parented under and can currently approve/deny it.", "The caller had successfully approved/denied this grant earlier." ], "enum": [ "CALLER_RELATIONSHIP_TYPE_UNSPECIFIED", "HAD_CREATED", "CAN_APPROVE", "HAD_APPROVED" ], "location": "query", "description": "Required. Only grants which the caller is related to by this relationship are returned in the response.", "type": "string" }, "filter": { "location": "query", "description": "Optional. Only grants matching this filter are returned in the response.", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, server picks an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SearchGrantsResponse" }, "description": "`SearchGrants` returns grants that are related to the calling user in the specified way." }, "create": { "request": { "$ref": "Grant" }, "description": "Creates a grant in a given project, folder, or organization and location.", "parameters": { "parent": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "description": "Required. Name of the parent entitlement for which this grant is being requested.", "type": "string" }, "requestId": { "location": "query", "description": "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. This prevents clients from accidentally creating duplicate grants. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "Grant" }, "path": "v1beta/{+parent}/grants", "httpMethod": "POST", "id": "privilegedaccessmanager.folders.locations.entitlements.grants.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants" }, "deny": { "id": "privilegedaccessmanager.folders.locations.entitlements.grants.deny", "httpMethod": "POST", "path": "v1beta/{+name}:deny", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:deny", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "DenyGrantRequest" }, "description": "`DenyGrant` is used to deny a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone.", "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "description": "Required. Name of the grant resource which is being denied.", "type": "string" } } }, "get": { "path": "v1beta/{+name}", "id": "privilegedaccessmanager.folders.locations.entitlements.grants.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}", "description": "Get details of a single grant.", "parameters": { "name": { "description": "Required. Name of the resource.", "type": "string", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Grant" } }, "approve": { "request": { "$ref": "ApproveGrantRequest" }, "description": "`ApproveGrant` is used to approve a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone.", "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "description": "Required. Name of the grant resource which is being approved.", "type": "string" } }, "httpMethod": "POST", "id": "privilegedaccessmanager.folders.locations.entitlements.grants.approve", "path": "v1beta/{+name}:approve", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:approve", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}", "path": "v1beta/{+name}", "id": "privilegedaccessmanager.folders.locations.entitlements.patch", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "description": "Identifier. Name of the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}`", "type": "string" }, "updateMask": { "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`) A value of '*' for this field refers to full replacement of the resource.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "Entitlement" }, "description": "Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants. The following fields are not supported for updates: * All immutable fields * Entitlement name * Resource name * Resource type * Adding an approval workflow in an entitlement which previously had no approval workflow. * Deleting the approval workflow from an entitlement. * Adding or deleting a step in the approval workflow (only one step is supported) Note that updates are allowed on the list of approvers in an approval workflow step." }, "list": { "description": "Lists the entitlements in a given project, folder, organization, and in a given location.", "parameters": { "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer" }, "filter": { "location": "query", "description": "Optional. Filtering results.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results.", "type": "string" }, "parent": { "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent which owns the entitlement resources.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListEntitlementsResponse" }, "path": "v1beta/{+parent}/entitlements", "id": "privilegedaccessmanager.folders.locations.entitlements.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements" }, "search": { "description": "`SearchEntitlements` returns entitlements on which the caller has the specified access.", "parameterOrder": [ "parent" ], "response": { "$ref": "SearchEntitlementsResponse" }, "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "type": "integer" }, "callerAccessType": { "description": "Required. Only entitlements where the calling user has this access are returned.", "type": "string", "location": "query", "enumDescriptions": [ "Unspecified access type.", "The user has access to create grants using this entitlement.", "The user has access to approve/deny grants created under this entitlement." ], "enum": [ "CALLER_ACCESS_TYPE_UNSPECIFIED", "GRANT_REQUESTER", "GRANT_APPROVER" ] }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "parent": { "description": "Required. The parent which owns the entitlement resources.", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path" }, "filter": { "location": "query", "description": "Optional. Only entitlements matching this filter are returned in the response.", "type": "string" } }, "httpMethod": "GET", "id": "privilegedaccessmanager.folders.locations.entitlements.search", "path": "v1beta/{+parent}/entitlements:search", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "privilegedaccessmanager.folders.locations.entitlements.create", "path": "v1beta/{+parent}/entitlements", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "parameters": { "requestId": { "description": "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).", "type": "string", "location": "query" }, "parent": { "description": "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}`", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path" }, "entitlementId": { "description": "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`.", "type": "string", "location": "query" } }, "request": { "$ref": "Entitlement" }, "description": "Creates a new entitlement in a given project, folder, organization, and in a given location." }, "delete": { "parameters": { "requestId": { "location": "query", "description": "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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "force": { "location": "query", "description": "Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)", "type": "boolean" }, "name": { "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the resource.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}", "path": "v1beta/{+name}", "id": "privilegedaccessmanager.folders.locations.entitlements.delete", "httpMethod": "DELETE" }, "get": { "path": "v1beta/{+name}", "id": "privilegedaccessmanager.folders.locations.entitlements.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}", "description": "Gets details of a single entitlement.", "parameters": { "name": { "description": "Required. Name of the resource.", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Entitlement" } } } } } } } } } }