Contact UsTry it for free
© 2025 Direct Cursus Technology L.L.C.

Identity Hub API, gRPC: OrganizationService.BindAccessPolicy

Written by
Updated at December 15, 2025

Binds the access policy template to the organization.

gRPC request

rpc BindAccessPolicy (access.BindAccessPolicyRequest) returns (operation.Operation)

access.BindAccessPolicyRequest

{
  "resource_id": "string",
  "access_policy_binding": {
    "access_policy_template_id": "string",
    "parameters": "map<string, string>"
  }
}

Field

Description

resource_id

string

Required field. ID of the resource for which access policy bindings are being set.

To get the resource ID, use a corresponding List request.

The maximum string length in characters is 50.

access_policy_binding

AccessPolicyBinding

Required field.

AccessPolicyBinding

Field

Description

access_policy_template_id

string

Required field. ID of the access policy template being applied.

The maximum string length in characters is 50.

parameters

object (map<string, string>)

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "resource_id": "string",
    "access_policy_binding": {
      "access_policy_template_id": "string",
      "parameters": "map<string, string>"
    }
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "BindAccessPolicyResponse"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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.

metadata

BindAccessPolicyMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

BindAccessPolicyResponse

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

BindAccessPolicyMetadata

Field

Description

resource_id

string

ID of the resource for which access policy bindings are being set.

access_policy_binding

AccessPolicyBinding

AccessPolicyBinding

Field

Description

access_policy_template_id

string

Required field. ID of the access policy template being applied.

The maximum string length in characters is 50.

parameters

object (map<string, string>)

BindAccessPolicyResponse

Field

Description

Empty
Previous
ListAccessPolicyBindings
Next
UnbindAccessPolicy