{
"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."
}
}
}
},
"basePath": "",
"baseUrl": "https://accessapproval.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Access Approval",
"description": "An API for controlling access to data by Google personnel.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/assured-workloads/access-approval/docs",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "accessapproval:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://accessapproval.mtls.googleapis.com/",
"name": "accessapproval",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"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",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"folders": {
"methods": {
"deleteAccessApprovalSettings": {
"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.",
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
"httpMethod": "DELETE",
"id": "accessapproval.folders.deleteAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to delete.",
"location": "path",
"pattern": "^folders/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getAccessApprovalSettings": {
"description": "Gets the Access Approval settings associated with a project, folder, or organization.",
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
"httpMethod": "GET",
"id": "accessapproval.folders.getAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^folders/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getServiceAccount": {
"description": "Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.",
"flatPath": "v1/folders/{foldersId}/serviceAccount",
"httpMethod": "GET",
"id": "accessapproval.folders.getServiceAccount",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalServiceAccount to retrieve.",
"location": "path",
"pattern": "^folders/[^/]+/serviceAccount$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.",
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
"httpMethod": "PATCH",
"id": "accessapproval.folders.updateAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the settings. Format is one of: * \"projects/{project}/accessApprovalSettings\" * \"folders/{folder}/accessApprovalSettings\" * \"organizations/{organization}/accessApprovalSettings\"",
"location": "path",
"pattern": "^folders/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "AccessApprovalSettings"
},
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"approvalRequests": {
"methods": {
"approve": {
"description": "Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:approve",
"httpMethod": "POST",
"id": "accessapproval.folders.approvalRequests.approve",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the approval request to approve.",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:approve",
"request": {
"$ref": "ApproveApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"dismiss": {
"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:dismiss",
"httpMethod": "POST",
"id": "accessapproval.folders.approvalRequests.dismiss",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to dismiss.",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:dismiss",
"request": {
"$ref": "DismissApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}",
"httpMethod": "GET",
"id": "accessapproval.folders.approvalRequests.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"invalidate": {
"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:invalidate",
"httpMethod": "POST",
"id": "accessapproval.folders.approvalRequests.invalidate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to invalidate.",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:invalidate",
"request": {
"$ref": "InvalidateApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.",
"flatPath": "v1/folders/{foldersId}/approvalRequests",
"httpMethod": "GET",
"id": "accessapproval.folders.approvalRequests.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying the page of results to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource. This may be \"projects/{project}\", \"folders/{folder}\", or \"organizations/{organization}\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"organizations": {
"methods": {
"deleteAccessApprovalSettings": {
"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.",
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
"httpMethod": "DELETE",
"id": "accessapproval.organizations.deleteAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to delete.",
"location": "path",
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getAccessApprovalSettings": {
"description": "Gets the Access Approval settings associated with a project, folder, or organization.",
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
"httpMethod": "GET",
"id": "accessapproval.organizations.getAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getServiceAccount": {
"description": "Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.",
"flatPath": "v1/organizations/{organizationsId}/serviceAccount",
"httpMethod": "GET",
"id": "accessapproval.organizations.getServiceAccount",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalServiceAccount to retrieve.",
"location": "path",
"pattern": "^organizations/[^/]+/serviceAccount$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.",
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
"httpMethod": "PATCH",
"id": "accessapproval.organizations.updateAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the settings. Format is one of: * \"projects/{project}/accessApprovalSettings\" * \"folders/{folder}/accessApprovalSettings\" * \"organizations/{organization}/accessApprovalSettings\"",
"location": "path",
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "AccessApprovalSettings"
},
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"approvalRequests": {
"methods": {
"approve": {
"description": "Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:approve",
"httpMethod": "POST",
"id": "accessapproval.organizations.approvalRequests.approve",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the approval request to approve.",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:approve",
"request": {
"$ref": "ApproveApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"dismiss": {
"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:dismiss",
"httpMethod": "POST",
"id": "accessapproval.organizations.approvalRequests.dismiss",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to dismiss.",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:dismiss",
"request": {
"$ref": "DismissApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}",
"httpMethod": "GET",
"id": "accessapproval.organizations.approvalRequests.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"invalidate": {
"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:invalidate",
"httpMethod": "POST",
"id": "accessapproval.organizations.approvalRequests.invalidate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to invalidate.",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:invalidate",
"request": {
"$ref": "InvalidateApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.",
"flatPath": "v1/organizations/{organizationsId}/approvalRequests",
"httpMethod": "GET",
"id": "accessapproval.organizations.approvalRequests.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying the page of results to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource. This may be \"projects/{project}\", \"folders/{folder}\", or \"organizations/{organization}\".",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"projects": {
"methods": {
"deleteAccessApprovalSettings": {
"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.",
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
"httpMethod": "DELETE",
"id": "accessapproval.projects.deleteAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to delete.",
"location": "path",
"pattern": "^projects/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getAccessApprovalSettings": {
"description": "Gets the Access Approval settings associated with a project, folder, or organization.",
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
"httpMethod": "GET",
"id": "accessapproval.projects.getAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^projects/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getServiceAccount": {
"description": "Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.",
"flatPath": "v1/projects/{projectsId}/serviceAccount",
"httpMethod": "GET",
"id": "accessapproval.projects.getServiceAccount",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalServiceAccount to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/serviceAccount$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AccessApprovalServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.",
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
"httpMethod": "PATCH",
"id": "accessapproval.projects.updateAccessApprovalSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the settings. Format is one of: * \"projects/{project}/accessApprovalSettings\" * \"folders/{folder}/accessApprovalSettings\" * \"organizations/{organization}/accessApprovalSettings\"",
"location": "path",
"pattern": "^projects/[^/]+/accessApprovalSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "AccessApprovalSettings"
},
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"approvalRequests": {
"methods": {
"approve": {
"description": "Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:approve",
"httpMethod": "POST",
"id": "accessapproval.projects.approvalRequests.approve",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the approval request to approve.",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:approve",
"request": {
"$ref": "ApproveApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"dismiss": {
"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:dismiss",
"httpMethod": "POST",
"id": "accessapproval.projects.approvalRequests.dismiss",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to dismiss.",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:dismiss",
"request": {
"$ref": "DismissApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}",
"httpMethod": "GET",
"id": "accessapproval.projects.approvalRequests.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"invalidate": {
"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:invalidate",
"httpMethod": "POST",
"id": "accessapproval.projects.approvalRequests.invalidate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the ApprovalRequest to invalidate.",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:invalidate",
"request": {
"$ref": "InvalidateApprovalRequestMessage"
},
"response": {
"$ref": "ApprovalRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.",
"flatPath": "v1/projects/{projectsId}/approvalRequests",
"httpMethod": "GET",
"id": "accessapproval.projects.approvalRequests.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying the page of results to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource. This may be \"projects/{project}\", \"folders/{folder}\", or \"organizations/{organization}\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20260126",
"rootUrl": "https://accessapproval.googleapis.com/",
"schemas": {
"AccessApprovalServiceAccount": {
"description": "Access Approval service account related to a project/folder/organization.",
"id": "AccessApprovalServiceAccount",
"properties": {
"accountEmail": {
"description": "Email address of the service account.",
"type": "string"
},
"name": {
"description": "The resource name of the Access Approval service account. Format is one of: * \"projects/{project}/serviceAccount\" * \"folders/{folder}/serviceAccount\" * \"organizations/{organization}/serviceAccount\"",
"type": "string"
}
},
"type": "object"
},
"AccessApprovalSettings": {
"description": "Settings on a Project/Folder/Organization related to Access Approval.",
"id": "AccessApprovalSettings",
"properties": {
"activeKeyVersion": {
"description": "The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.",
"type": "string"
},
"ancestorHasActiveKeyVersion": {
"description": "Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).",
"readOnly": true,
"type": "boolean"
},
"ancestorsEnrolledServices": {
"description": "Output only. Field to differentiate ancestor enrolled services from locally enrolled services.",
"items": {
"$ref": "EnrolledService"
},
"readOnly": true,
"type": "array"
},
"approvalPolicy": {
"$ref": "CustomerApprovalApprovalPolicy",
"description": "Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required."
},
"effectiveApprovalPolicy": {
"$ref": "CustomerApprovalApprovalPolicy",
"description": "Output only. Effective policy applied for Access Approval, inclusive of inheritance.",
"readOnly": true
},
"enrolledAncestor": {
"description": "Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).",
"readOnly": true,
"type": "boolean"
},
"enrolledServices": {
"description": "A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.",
"items": {
"$ref": "EnrolledService"
},
"type": "array"
},
"invalidKeyVersion": {
"description": "Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "The resource name of the settings. Format is one of: * \"projects/{project}/accessApprovalSettings\" * \"folders/{folder}/accessApprovalSettings\" * \"organizations/{organization}/accessApprovalSettings\"",
"type": "string"
},
"notificationEmails": {
"description": "A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"notificationPubsubTopic": {
"description": "Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.",
"type": "string"
},
"preferNoBroadApprovalRequests": {
"description": "This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.",
"type": "boolean"
},
"preferredRequestExpirationDays": {
"description": "Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.",
"format": "int32",
"type": "integer"
},
"requestScopeMaxWidthPreference": {
"description": "Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.",
"enum": [
"REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED",
"ORGANIZATION",
"FOLDER",
"PROJECT"
],
"enumDescriptions": [
"Default value, defaults to ORGANIZATION if not set. This value is not able to be configured by the user, do not use.",
"This is the widest scope possible. It means the customer has no scope restriction when it comes to Access Approval requests.",
"Customer allows the scope of Access Approval requests as broad as the Folder level.",
"Customer allows the scope of Access Approval requests as broad as the Project level."
],
"type": "string"
},
"requireCustomerVisibleJustification": {
"description": "Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as \"Require customer initiated support case justification\"",
"type": "boolean"
}
},
"type": "object"
},
"AccessLocations": {
"description": "Physical assigned office and physical location of the Google administrator performing the access.",
"id": "AccessLocations",
"properties": {
"principalOfficeCountry": {
"description": "The \"home office\" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location",
"type": "string"
},
"principalPhysicalLocationCountry": {
"description": "Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location",
"type": "string"
}
},
"type": "object"
},
"AccessReason": {
"id": "AccessReason",
"properties": {
"detail": {
"description": "More detail about certain reason types. See comments for each type above.",
"type": "string"
},
"type": {
"description": "Type of access reason.",
"enum": [
"TYPE_UNSPECIFIED",
"CUSTOMER_INITIATED_SUPPORT",
"GOOGLE_INITIATED_SERVICE",
"GOOGLE_INITIATED_REVIEW",
"THIRD_PARTY_DATA_REQUEST",
"GOOGLE_RESPONSE_TO_PRODUCTION_ALERT",
"CLOUD_INITIATED_ACCESS"
],
"enumDescriptions": [
"This value is not used.",
"Customer made a request or raised an issue that required the principal to access customer data. `detail` is of the form (\"#####\" is the issue ID): * \"Feedback Report: #####\" * \"Case Number: #####\" * \"Case ID: #####\" * \"E-PIN Reference: #####\" * \"Google-#####\" * \"T-#####\"",
"The principal accessed customer data in order to diagnose or resolve a suspected issue in services. Often this access is used to confirm that customers are not affected by a suspected service issue or to remediate a reversible system issue.",
"Google initiated service for security, fraud, abuse, or compliance purposes.",
"The principal was compelled to access customer data in order to respond to a legal third party data request or process, including legal processes from customers themselves.",
"The principal accessed customer data in order to diagnose or resolve a suspected issue in services or a known outage.",
"Similar to 'GOOGLE_INITIATED_SERVICE' or 'GOOGLE_INITIATED_REVIEW', but with universe agnostic naming. The principal accessed customer data in order to diagnose or resolve a suspected issue in services or a known outage, or for security, fraud, abuse, or compliance review purposes."
],
"type": "string"
}
},
"type": "object"
},
"ApprovalRequest": {
"description": "A request for the customer to approve access to a resource.",
"id": "ApprovalRequest",
"properties": {
"approve": {
"$ref": "ApproveDecision",
"description": "Access was approved."
},
"dismiss": {
"$ref": "DismissDecision",
"description": "The request was dismissed."
},
"name": {
"description": "The resource name of the request. Format is \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\".",
"type": "string"
},
"requestTime": {
"description": "The time at which approval was requested.",
"format": "google-datetime",
"type": "string"
},
"requestedAugmentedInfo": {
"$ref": "AugmentedInfo",
"description": "This field contains the augmented information of the request."
},
"requestedDuration": {
"description": "The requested access duration.",
"format": "google-duration",
"type": "string"
},
"requestedExpiration": {
"description": "The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.",
"format": "google-datetime",
"type": "string"
},
"requestedLocations": {
"$ref": "AccessLocations",
"description": "The locations for which approval is being requested."
},
"requestedReason": {
"$ref": "AccessReason",
"description": "The access reason for which approval is being requested."
},
"requestedResourceName": {
"description": "The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a \"full\" resource name (e.g. \"//library.googleapis.com/shelves/shelf1/books/book2\") or a \"relative\" resource name (e.g. \"shelves/shelf1/books/book2\") as described in the resource name specification.",
"type": "string"
},
"requestedResourceProperties": {
"$ref": "ResourceProperties",
"description": "Properties related to the resource represented by requested_resource_name."
}
},
"type": "object"
},
"ApproveApprovalRequestMessage": {
"description": "Request to approve an ApprovalRequest.",
"id": "ApproveApprovalRequestMessage",
"properties": {
"expireTime": {
"description": "The expiration time of this approval.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ApproveDecision": {
"description": "A decision that has been made to approve access to a resource.",
"id": "ApproveDecision",
"properties": {
"approveTime": {
"description": "The time at which approval was granted.",
"format": "google-datetime",
"type": "string"
},
"autoApproved": {
"description": "True when the request has been auto-approved.",
"type": "boolean"
},
"expireTime": {
"description": "The time at which the approval expires.",
"format": "google-datetime",
"type": "string"
},
"invalidateTime": {
"description": "If set, denotes the timestamp at which the approval is invalidated.",
"format": "google-datetime",
"type": "string"
},
"policyApproved": {
"description": "True when the request has been approved by the customer's defined policy.",
"type": "boolean"
},
"signatureInfo": {
"$ref": "SignatureInfo",
"description": "The signature for the ApprovalRequest and details on how it was signed."
}
},
"type": "object"
},
"AugmentedInfo": {
"description": "This field contains the augmented information of the request. Requires augmented administrative access to be enabled.",
"id": "AugmentedInfo",
"properties": {
"command": {
"description": "For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).",
"type": "string"
}
},
"type": "object"
},
"CustomerApprovalApprovalPolicy": {
"description": "Represents all the policies that can be set for Customer Approval.",
"id": "CustomerApprovalApprovalPolicy",
"properties": {
"justificationBasedApprovalPolicy": {
"description": "Optional. Policy for approval based on the justification given.",
"enum": [
"JUSTIFICATION_BASED_APPROVAL_POLICY_UNSPECIFIED",
"JUSTIFICATION_BASED_APPROVAL_ENABLED_ALL",
"JUSTIFICATION_BASED_APPROVAL_ENABLED_EXTERNAL_JUSTIFICATIONS",
"JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED",
"JUSTIFICATION_BASED_APPROVAL_INHERITED"
],
"enumDescriptions": [
"Default value, defaults to JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED if not set. This value is not able to be configured by the user, do not use.",
"Audit-only mode. All accesses are pre-approved instantly.",
"Customer initiated support access reasons are pre-approved instantly. All other accesses require customer approval.",
"All access approval requests require customer approval. This is the default value if the policy is not set.",
"Defer configuration to parent settings. This is the default value if the policy is not set and the parent has a value set."
],
"type": "string"
}
},
"type": "object"
},
"DismissApprovalRequestMessage": {
"description": "Request to dismiss an approval request.",
"id": "DismissApprovalRequestMessage",
"properties": {},
"type": "object"
},
"DismissDecision": {
"description": "A decision that has been made to dismiss an approval request.",
"id": "DismissDecision",
"properties": {
"dismissTime": {
"description": "The time at which the approval request was dismissed.",
"format": "google-datetime",
"type": "string"
},
"implicit": {
"description": "This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).",
"type": "boolean"
}
},
"type": "object"
},
"Empty": {
"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); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"EnrolledService": {
"description": "Represents the enrollment of a cloud resource into a specific service.",
"id": "EnrolledService",
"properties": {
"cloudProduct": {
"description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services",
"type": "string"
},
"enrollmentLevel": {
"description": "The enrollment level of the service.",
"enum": [
"ENROLLMENT_LEVEL_UNSPECIFIED",
"BLOCK_ALL"
],
"enumDescriptions": [
"Default value if not set, defaults to \"BLOCK_ALL\". This value is not available to be set by the user, do not use.",
"Service is enrolled in Access Approval for all requests"
],
"type": "string"
}
},
"type": "object"
},
"InvalidateApprovalRequestMessage": {
"description": "Request to invalidate an existing approval.",
"id": "InvalidateApprovalRequestMessage",
"properties": {},
"type": "object"
},
"ListApprovalRequestsResponse": {
"description": "Response to listing of ApprovalRequest objects.",
"id": "ListApprovalRequestsResponse",
"properties": {
"approvalRequests": {
"description": "Approval request details.",
"items": {
"$ref": "ApprovalRequest"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more.",
"type": "string"
}
},
"type": "object"
},
"ResourceProperties": {
"description": "The properties associated with the resource of the request.",
"id": "ResourceProperties",
"properties": {
"excludesDescendants": {
"description": "Whether an approval will exclude the descendants of the resource being requested.",
"type": "boolean"
}
},
"type": "object"
},
"SignatureInfo": {
"description": "Information about the digital signature of the resource.",
"id": "SignatureInfo",
"properties": {
"customerKmsKeyVersion": {
"description": "The resource name of the customer CryptoKeyVersion used for signing.",
"type": "string"
},
"googleKeyAlgorithm": {
"description": "The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.",
"enum": [
"CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED",
"GOOGLE_SYMMETRIC_ENCRYPTION",
"AES_128_GCM",
"AES_256_GCM",
"AES_128_CBC",
"AES_256_CBC",
"AES_128_CTR",
"AES_256_CTR",
"RSA_SIGN_PSS_2048_SHA256",
"RSA_SIGN_PSS_3072_SHA256",
"RSA_SIGN_PSS_4096_SHA256",
"RSA_SIGN_PSS_4096_SHA512",
"RSA_SIGN_PKCS1_2048_SHA256",
"RSA_SIGN_PKCS1_3072_SHA256",
"RSA_SIGN_PKCS1_4096_SHA256",
"RSA_SIGN_PKCS1_4096_SHA512",
"RSA_SIGN_RAW_PKCS1_2048",
"RSA_SIGN_RAW_PKCS1_3072",
"RSA_SIGN_RAW_PKCS1_4096",
"RSA_DECRYPT_OAEP_2048_SHA256",
"RSA_DECRYPT_OAEP_3072_SHA256",
"RSA_DECRYPT_OAEP_4096_SHA256",
"RSA_DECRYPT_OAEP_4096_SHA512",
"RSA_DECRYPT_OAEP_2048_SHA1",
"RSA_DECRYPT_OAEP_3072_SHA1",
"RSA_DECRYPT_OAEP_4096_SHA1",
"EC_SIGN_P256_SHA256",
"EC_SIGN_P384_SHA384",
"EC_SIGN_SECP256K1_SHA256",
"EC_SIGN_ED25519",
"HMAC_SHA256",
"HMAC_SHA1",
"HMAC_SHA384",
"HMAC_SHA512",
"HMAC_SHA224",
"EXTERNAL_SYMMETRIC_ENCRYPTION",
"ML_KEM_768",
"ML_KEM_1024",
"KEM_XWING",
"PQ_SIGN_ML_DSA_44",
"PQ_SIGN_ML_DSA_65",
"PQ_SIGN_ML_DSA_87",
"PQ_SIGN_SLH_DSA_SHA2_128S",
"PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256",
"PQ_SIGN_ML_DSA_44_EXTERNAL_MU",
"PQ_SIGN_ML_DSA_65_EXTERNAL_MU",
"PQ_SIGN_ML_DSA_87_EXTERNAL_MU"
],
"enumDescriptions": [
"Not specified.",
"Creates symmetric encryption keys.",
"AES-GCM (Galois Counter Mode) using 128-bit keys.",
"AES-GCM (Galois Counter Mode) using 256-bit keys.",
"AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.",
"AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.",
"AES-CTR (Counter Mode) using 128-bit keys.",
"AES-CTR (Counter Mode) using 256-bit keys.",
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
"RSASSA-PSS 3072 bit key with a SHA256 digest.",
"RSASSA-PSS 4096 bit key with a SHA256 digest.",
"RSASSA-PSS 4096 bit key with a SHA512 digest.",
"RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 2048 bit key.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 3072 bit key.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 4096 bit key.",
"RSAES-OAEP 2048 bit key with a SHA256 digest.",
"RSAES-OAEP 3072 bit key with a SHA256 digest.",
"RSAES-OAEP 4096 bit key with a SHA256 digest.",
"RSAES-OAEP 4096 bit key with a SHA512 digest.",
"RSAES-OAEP 2048 bit key with a SHA1 digest.",
"RSAES-OAEP 3072 bit key with a SHA1 digest.",
"RSAES-OAEP 4096 bit key with a SHA1 digest.",
"ECDSA on the NIST P-256 curve with a SHA256 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"ECDSA on the NIST P-384 curve with a SHA384 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"ECDSA on the non-NIST secp256k1 curve. This curve is only supported for HSM protection level. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"EdDSA on the Curve25519 in pure mode (taking data as input).",
"HMAC-SHA256 signing with a 256 bit key.",
"HMAC-SHA1 signing with a 160 bit key.",
"HMAC-SHA384 signing with a 384 bit key.",
"HMAC-SHA512 signing with a 512 bit key.",
"HMAC-SHA224 signing with a 224 bit key.",
"Algorithm representing symmetric encryption by an external key manager.",
"ML-KEM-768 (FIPS 203)",
"ML-KEM-1024 (FIPS 203)",
"X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.",
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.",
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.",
"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.",
"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.",
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.",
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.",
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives."
],
"type": "string"
},
"googlePublicKeyPem": {
"description": "The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.",
"type": "string"
},
"serializedApprovalRequest": {
"description": "The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.",
"format": "byte",
"type": "string"
},
"signature": {
"description": "The digital signature.",
"format": "byte",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Access Approval API",
"version": "v1",
"version_module": true
}