Discovery Engine API . projects . locations . userStores

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

Updates the User License. This method is used for batch assign/unassign licenses to users.

Args:
  parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for UserLicenseService.BatchUpdateUserLicenses method.
  "deleteUnassignedUserLicenses": True or False, # Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.
  "inlineSource": { # The inline source for the input config for BatchUpdateUserLicenses method. # The inline source for the input content for document embeddings.
    "updateMask": "A String", # Optional. The list of fields to update.
    "userLicenses": [ # Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal.
      { # User License information assigned by the admin.
        "createTime": "A String", # Output only. User created timestamp.
        "lastLoginTime": "A String", # Output only. User last logged in time. If the user has not logged in yet, this field will be empty.
        "licenseAssignmentState": "A String", # Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;
        "licenseConfig": "A String", # Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.
        "updateTime": "A String", # Output only. User update timestamp.
        "userPrincipal": "A String", # Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.
        "userProfile": "A String", # Optional. The user profile. We user user full name(First name + Last name) as user profile.
      },
    ],
  },
}

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

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # 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.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

close()

Close httplib2 connections.