Google Marketing Platform Admin API . organizations . adminAccessBindings

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates an admin access binding in the specified GMP organization.

Args:
  parent: string, Required. The parent organization, which owns this Admin Access Binding. Format: organizations/{org_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a binding to a set of roles.
  "name": "A String", # Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def"
  "organizationRoles": [ # Optional. A list of roles granted to the parent organization. USER_ADMIN_ROLE and BILLING_ADMIN_ROLE will be automatically added if ORG_ADMIN_ROLE is assigned. No roles will be assigned if no roles are specified.
    "A String",
  ],
  "userEmail": "A String", # Email address of the user.
  "userGroup": "A String", # Resource name of the user group.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a binding to a set of roles.
  "name": "A String", # Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def"
  "organizationRoles": [ # Optional. A list of roles granted to the parent organization. USER_ADMIN_ROLE and BILLING_ADMIN_ROLE will be automatically added if ORG_ADMIN_ROLE is assigned. No roles will be assigned if no roles are specified.
    "A String",
  ],
  "userEmail": "A String", # Email address of the user.
  "userGroup": "A String", # Resource name of the user group.
}

get(name, x__xgafv=None)

Looks up a single admin access binding.

Args:
  name: string, Required. The name of the AdminAccessBinding to retrieve. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a binding to a set of roles.
  "name": "A String", # Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def"
  "organizationRoles": [ # Optional. A list of roles granted to the parent organization. USER_ADMIN_ROLE and BILLING_ADMIN_ROLE will be automatically added if ORG_ADMIN_ROLE is assigned. No roles will be assigned if no roles are specified.
    "A String",
  ],
  "userEmail": "A String", # Email address of the user.
  "userGroup": "A String", # Resource name of the user group.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns a list of admin access bindings in the specified GMP organization.

Args:
  parent: string, Required. The parent organization, which owns this collection of Admin Access Bindings. Format: organizations/{org_id} (required)
  pageSize: integer, Optional. The maximum number of Admin Access Bindings to return in one call. The service may return fewer than this value. If unspecified, at most 50 Admin Access Bindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous ListAdminAccessBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdminAccessBindings` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListAdminAccessBindings RPC.
  "adminAccessBindings": [ # Admin Access Bindings in the organization.
    { # A resource message representing a binding to a set of roles.
      "name": "A String", # Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def"
      "organizationRoles": [ # Optional. A list of roles granted to the parent organization. USER_ADMIN_ROLE and BILLING_ADMIN_ROLE will be automatically added if ORG_ADMIN_ROLE is assigned. No roles will be assigned if no roles are specified.
        "A String",
      ],
      "userEmail": "A String", # Email address of the user.
      "userGroup": "A String", # Resource name of the user group.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an admin access binding in the specified GMP organization.

Args:
  name: string, Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def" (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a binding to a set of roles.
  "name": "A String", # Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def"
  "organizationRoles": [ # Optional. A list of roles granted to the parent organization. USER_ADMIN_ROLE and BILLING_ADMIN_ROLE will be automatically added if ORG_ADMIN_ROLE is assigned. No roles will be assigned if no roles are specified.
    "A String",
  ],
  "userEmail": "A String", # Email address of the user.
  "userGroup": "A String", # Resource name of the user group.
}

  updateMask: string, Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a binding to a set of roles.
  "name": "A String", # Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def"
  "organizationRoles": [ # Optional. A list of roles granted to the parent organization. USER_ADMIN_ROLE and BILLING_ADMIN_ROLE will be automatically added if ORG_ADMIN_ROLE is assigned. No roles will be assigned if no roles are specified.
    "A String",
  ],
  "userEmail": "A String", # Email address of the user.
  "userGroup": "A String", # Resource name of the user group.
}