--- title: "POST /v1/{+parent}:requestAccess" method: POST path: "/v1/{+parent}:requestAccess" tags: ["projects"] --- # POST /v1/{+parent}:requestAccess `POST /v1/{+parent}:requestAccess` Requests access to a data product. This will trigger an access approval workflow, and the requester will need to wait for the approval to be granted before they will be able to access the data product assets. ## Path parameters - `parent` string, required ## Request body - GoogleCloudDataplexV1RequestDataProductAccessRequest — Message for requesting access to a Data Product. - `changeRequest` GoogleCloudDataplexV1ChangeRequest — Represents a proposed change to a metadata resource. - `justification` string — Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved. - `createGlossaryCategory` GoogleCloudDataplexV1CreateGlossaryCategoryRequest — Creates a new GlossaryCategory under the specified Glossary. - `categoryId` string — Required. GlossaryCategory identifier. - `parent` string — Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region. - `category` GoogleCloudDataplexV1GlossaryCategory — A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. - `createTime` string, google-datetime — Output only. The time at which the GlossaryCategory was created. - `updateTime` string, google-datetime — Output only. The time at which the GlossaryCategory was last updated. - `description` string — Optional. The user-mutable description of the GlossaryCategory. - `name` string — Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} - `parent` string — Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} - `uid` string — Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name. - `displayName` string — Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified. - `labels` object — Optional. User-defined labels for the GlossaryCategory. - `updateEntry` GoogleCloudDataplexV1UpdateEntryRequest — Update Entry request. - `deleteMissingAspects` boolean — Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. - `updateMask` string, google-fieldmask — Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. - `allowMissing` boolean — Optional. If set to true and the entry doesn't exist, the service will create it. - `entry` GoogleCloudDataplexV1Entry — An entry is a representation of a data resource that can be described by various metadata. - `name` string — Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - `fullyQualifiedName` string — Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. - `entryType` string — Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. - `updateTime` string, google-datetime — Output only. The time when the entry was last updated in Dataplex Universal Catalog. - `createTime` string, google-datetime — Output only. The time when the entry was created in Dataplex Universal Catalog. - `aspects` object — Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - `entrySource` GoogleCloudDataplexV1EntrySource — Information related to the source system of the data resource that is represented by the entry. - `displayName` string — A user-friendly display name. Maximum length is 500 characters. - `location` string — Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. - `system` string — The name of the source system. Maximum length is 64 characters. - `labels` object — User-defined labels. The maximum size of keys and values is 128 characters each. - `resource` string — The name of the resource in the source system. Maximum length is 4,000 characters. - `description` string — A description of the data resource. Maximum length is 2,000 characters. - `ancestors` GoogleCloudDataplexV1EntrySourceAncestor[] — Immutable. The entries representing the ancestors of the data resource in the source system. - `name` string — Optional. The name of the ancestor resource. - `type` string — Optional. The type of the ancestor resource. - `platform` string — The platform containing the source system. Maximum length is 64 characters. - `updateTime` string, google-datetime — The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. - `createTime` string, google-datetime — The time when the resource was created in the source system. - `parentEntry` string — Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - `aspectKeys` string[] — Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. - `deleteGlossaryTerm` GoogleCloudDataplexV1DeleteGlossaryTermRequest — Delete GlossaryTerm Request - `name` string — Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id} - `resource` string — Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry - `name` string — Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id} - `createGlossaryTerm` GoogleCloudDataplexV1CreateGlossaryTermRequest — Creates a new GlossaryTerm under the specified Glossary. - `term` GoogleCloudDataplexV1GlossaryTerm — GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. - `updateTime` string, google-datetime — Output only. The time at which the GlossaryTerm was last updated. - `createTime` string, google-datetime — Output only. The time at which the GlossaryTerm was created. - `name` string — Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id} - `description` string — Optional. The user-mutable description of the GlossaryTerm. - `uid` string — Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name. - `displayName` string — Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified. - `parent` string — Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} - `labels` object — Optional. User-defined labels for the GlossaryTerm. - `termId` string — Required. GlossaryTerm identifier. - `parent` string — Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region. - `updateGlossary` GoogleCloudDataplexV1UpdateGlossaryRequest — Update Glossary Request - `glossary` GoogleCloudDataplexV1Glossary — A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. - `updateTime` string, google-datetime — Output only. The time at which the Glossary was last updated. - `createTime` string, google-datetime — Output only. The time at which the Glossary was created. - `uid` string — Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name. - `categoryCount` integer — Output only. The number of GlossaryCategories in the Glossary. - `name` string — Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} - `etag` string — Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - `description` string — Optional. The user-mutable description of the Glossary. - `displayName` string — Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified. - `termCount` integer — Output only. The number of GlossaryTerms in the Glossary. - `labels` object — Optional. User-defined labels for the Glossary. - `validateOnly` boolean — Optional. Validates the request without actually updating the Glossary. Default: false. - `updateMask` string, google-fieldmask — Required. The list of fields to update. - `state` 'STATE_UNSPECIFIED' | 'NEW' | 'APPROVED' | 'REJECTED' | 'EXPIRED' | 'REVOKED' — Output only. The current state of the ChangeRequest. - `deleteEntry` GoogleCloudDataplexV1DeleteEntryRequest — Delete Entry request. - `name` string — Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. - `labels` object — Optional. User-defined labels for the ChangeRequest. - `createEntry` GoogleCloudDataplexV1CreateEntryRequest — Create Entry request. - `parent` string — Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. - `entryId` string — Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. - `entry` GoogleCloudDataplexV1Entry — An entry is a representation of a data resource that can be described by various metadata. - `name` string — Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - `fullyQualifiedName` string — Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. - `entryType` string — Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. - `updateTime` string, google-datetime — Output only. The time when the entry was last updated in Dataplex Universal Catalog. - `createTime` string, google-datetime — Output only. The time when the entry was created in Dataplex Universal Catalog. - `aspects` object — Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} - `entrySource` GoogleCloudDataplexV1EntrySource — Information related to the source system of the data resource that is represented by the entry. - `displayName` string — A user-friendly display name. Maximum length is 500 characters. - `location` string — Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. - `system` string — The name of the source system. Maximum length is 64 characters. - `labels` object — User-defined labels. The maximum size of keys and values is 128 characters each. - `resource` string — The name of the resource in the source system. Maximum length is 4,000 characters. - `description` string — A description of the data resource. Maximum length is 2,000 characters. - `ancestors` GoogleCloudDataplexV1EntrySourceAncestor[] — Immutable. The entries representing the ancestors of the data resource in the source system. - `name` string — Optional. The name of the ancestor resource. - `type` string — Optional. The type of the ancestor resource. - `platform` string — The platform containing the source system. Maximum length is 64 characters. - `updateTime` string, google-datetime — The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. - `createTime` string, google-datetime — The time when the resource was created in the source system. - `parentEntry` string — Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - `approver` string — Output only. The email address of the user who approved/rejected the ChangeRequest. - `updateGlossaryCategory` GoogleCloudDataplexV1UpdateGlossaryCategoryRequest — Update GlossaryCategory Request - `category` GoogleCloudDataplexV1GlossaryCategory — A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. - `createTime` string, google-datetime — Output only. The time at which the GlossaryCategory was created. - `updateTime` string, google-datetime — Output only. The time at which the GlossaryCategory was last updated. - `description` string — Optional. The user-mutable description of the GlossaryCategory. - `name` string — Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} - `parent` string — Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} - `uid` string — Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name. - `displayName` string — Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified. - `labels` object — Optional. User-defined labels for the GlossaryCategory. - `updateMask` string, google-fieldmask — Required. The list of fields to update. - `deleteGlossaryCategory` GoogleCloudDataplexV1DeleteGlossaryCategoryRequest — Delete GlossaryCategory Request - `name` string — Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} - `uid` string — Output only. System generated globally unique ID for the ChangeRequest. - `deleteEntryLink` GoogleCloudDataplexV1DeleteEntryLinkRequest — Request message for DeleteEntryLink. - `name` string — Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. - `createGlossary` GoogleCloudDataplexV1CreateGlossaryRequest — Create Glossary Request - `parent` string — Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region. - `glossary` GoogleCloudDataplexV1Glossary — A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. - `updateTime` string, google-datetime — Output only. The time at which the Glossary was last updated. - `createTime` string, google-datetime — Output only. The time at which the Glossary was created. - `uid` string — Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name. - `categoryCount` integer — Output only. The number of GlossaryCategories in the Glossary. - `name` string — Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} - `etag` string — Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - `description` string — Optional. The user-mutable description of the Glossary. - `displayName` string — Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified. - `termCount` integer — Output only. The number of GlossaryTerms in the Glossary. - `labels` object — Optional. User-defined labels for the Glossary. - `validateOnly` boolean — Optional. Validates the request without actually creating the Glossary. Default: false. - `glossaryId` string — Required. Glossary ID: Glossary identifier. - `createEntryLink` GoogleCloudDataplexV1CreateEntryLinkRequest — Request message for CreateEntryLink. - `entryLink` GoogleCloudDataplexV1EntryLink — EntryLink represents a link between two Entries. - `name` string — Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} - `entryReferences` GoogleCloudDataplexV1EntryLinkEntryReference[] — Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. - `name` string — Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} - `type` 'UNSPECIFIED' | 'SOURCE' | 'TARGET' — Required. Immutable. The reference type of the Entry. - `path` string — Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. - `createTime` string, google-datetime — Output only. The time when the Entry Link was created. - `aspects` object — Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. - `entryLinkType` string — Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition - `updateTime` string, google-datetime — Output only. The time when the Entry Link was last updated. - `parent` string — Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. - `entryLinkId` string — Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. - `rejectionComment` string — Output only. The reason provided for rejecting the ChangeRequest. - `author` string — Output only. The email address of the user who created the ChangeRequest. - `deleteGlossary` GoogleCloudDataplexV1DeleteGlossaryRequest — Delete Glossary Request - `name` string — Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} - `etag` string — Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code. - `etag` string — Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - `changeType` 'CHANGE_TYPE_UNSPECIFIED' | 'CREATE_ENTRY' | 'UPDATE_ENTRY' | 'DELETE_ENTRY' | 'CREATE_ENTRY_LINK' | 'DELETE_ENTRY_LINK' | 'CREATE_GLOSSARY' | 'UPDATE_GLOSSARY' | 'DELETE_GLOSSARY' | 'CREATE_GLOSSARY_CATEGORY' | 'UPDATE_GLOSSARY_CATEGORY' | 'DELETE_GLOSSARY_CATEGORY' | 'CREATE_GLOSSARY_TERM' | 'UPDATE_GLOSSARY_TERM' | 'DELETE_GLOSSARY_TERM' | 'REQUEST_DATA_PRODUCT_ACCESS' — Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. - `updateGlossaryTerm` GoogleCloudDataplexV1UpdateGlossaryTermRequest — Update GlossaryTerm Request - `updateMask` string, google-fieldmask — Required. The list of fields to update. - `term` GoogleCloudDataplexV1GlossaryTerm — GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. - `updateTime` string, google-datetime — Output only. The time at which the GlossaryTerm was last updated. - `createTime` string, google-datetime — Output only. The time at which the GlossaryTerm was created. - `name` string — Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id} - `description` string — Optional. The user-mutable description of the GlossaryTerm. - `uid` string — Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name. - `displayName` string — Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified. - `parent` string — Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} - `labels` object — Optional. User-defined labels for the GlossaryTerm. - `dataProductAccessRequest` GoogleCloudDataplexV1DataProductAccessRequest — Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. - `accessGroupId` string — Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product. - `parent` string — Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id} - `accessGroupDisplayName` string — Output only. The display name of the access group defined in the Data Product for which access is being requested. - `requestedPrincipal` string — Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers - `createTime` string, google-datetime — Output only. The time when the ChangeRequest was created. - `updateTime` string, google-datetime — Output only. The time when the ChangeRequest was last updated. - `validateOnly` boolean — Optional. Validates the request without actually creating the access change request. Defaults to false. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/dataplex.md) · [All operations](https://skmtc.net/google/apis/dataplex/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dataplex/versions/43a3b60ca93b/schema)