import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common'; import { Readable } from 'stream'; export declare namespace agentidentity_v1alpha { export interface Options extends GlobalOptions { version: 'v1alpha'; } interface StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth; /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * 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. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * 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. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * Agent Identity API * * * * @example * ```js * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * ``` */ export class Agentidentity { context: APIRequestContext; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * Represents an access summary. */ export interface Schema$AccessSummary { /** * Output only. The auth provider that this access summary is associated with. */ authProvider?: string | null; /** * Output only. The auth provider type used to create this access summary. */ authProviderType?: string | null; /** * Output only. The first time this user interacted with this workload, rounded to the previous hour. */ firstAccessTime?: string | null; /** * Optional. Labels as key-value pairs. */ labels?: { [key: string]: string; } | null; /** * Output only. The most recent time this user interacted with this workload, rounded to the previous hour. */ lastAccessTime?: string | null; /** * Output only. Identifier. The resource name of the access summary. */ name?: string | null; /** * Output only. The time when this access summary is permanently deleted. */ purgeTime?: string | null; /** * Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200. */ scopes?: string[] | null; /** * Output only. The URL of the authentication server that was accessed. */ tokenUrl?: string | null; /** * Output only. The user ID provided by the workload application for this user. Not verified by Google. */ userId?: string | null; /** * Output only. The identity bound to the workload that this user interacted with to produce this access summary. Typically an agentic SPIFFE ID. */ workloadId?: string | null; } /** * Marker message to indicate the managed Agent Identity Pool is used. */ export interface Schema$AgentIdentityPool { } /** * Configuration for API key authentication. */ export interface Schema$ApiKeyParams { /** * Optional. Input only. The API key for this auth provider. */ apiKey?: string | null; } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; /** * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string | null; } /** * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[] | null; /** * The log type that this config enables. */ logType?: string | null; } /** * Represents an authorization. */ export interface Schema$Authorization { /** * Output only. The client user ID provided by the client application for their end user. Not verified by Google. */ clientUserId?: string | null; /** * Output only. The creation timestamp. */ createTime?: string | null; /** * Identifier. The resource name of the authorization. */ name?: string | null; /** * Output only. The scopes actually granted by the end user during the consent flow. */ scopes?: string[] | null; /** * Output only. The state of the authorization. */ state?: string | null; /** * Output only. The update timestamp. */ updateTime?: string | null; } /** * Represents an auth provider. */ export interface Schema$AuthProvider { /** * Optional. List of scopes that are allowed to be requested for this auth provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200. */ allowedScopes?: string[] | null; /** * Required. Parameters specific to the auth provider type. */ authProviderTypeParams?: Schema$AuthProviderTypeParams; /** * Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. */ blockedScopes?: string[] | null; /** * Output only. The creation timestamp. */ createTime?: string | null; /** * Output only. Set to `true` if the auth provider is deleted. */ deleted?: boolean | null; /** * Optional. Description of the resource. Must be less than 256 characters. */ description?: string | null; /** * Output only. The time when the auth provider will expire. */ expireTime?: string | null; /** * Optional. Labels as key-value pairs. */ labels?: { [key: string]: string; } | null; /** * Identifier. The full resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ name?: string | null; /** * Output only. The state of the auth provider. */ state?: string | null; /** * Output only. The update timestamp. */ updateTime?: string | null; /** * Optional. Input only. Identifiers for the agents that will use this auth provider, starting with `principal://`. For example: `principal://agents.global.org-${ORG_ID\}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID\}/locations/{LOCATIONS\}/reasoningEngines/{ID\}` */ workloadIds?: string[] | null; } /** * Required. Parameters specific to the auth provider type. */ export interface Schema$AuthProviderTypeParams { /** * Parameters for API key authentication. */ apiKey?: Schema$ApiKeyParams; /** * Parameters for Connector Reference authentication. */ connectorReferenceAuthProvider?: Schema$ConnectorReferenceAuthProvider; /** * Parameters for Gemini Enterprise authentication. */ geAuthProvider?: Schema$GeminiEnterpriseAuthProviderParams; /** * Parameters for 3-legged OAuth (3LO) authentication. */ threeLeggedOauth?: Schema$ThreeLeggedOAuth; /** * Parameters for 2-legged OAuth (2LO) authentication. */ twoLeggedOauth?: Schema$TwoLeggedOAuth; /** * Parameters for Cross-App Access authentication. */ xaaAuthProvider?: Schema$CrossAppAccessAuthProvider; } /** * Associates `members`, or principals, with a `role`. */ export interface Schema$Binding { /** * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. */ members?: string[] | null; /** * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). */ role?: string | null; } /** * Configuration for client ID and client assertion JWT authentication. */ export interface Schema$ClientAssertionJwtAuth { /** * Required. The client identifier. */ clientId?: string | null; } /** * Configuration for client ID and client secret authentication. */ export interface Schema$ClientSecretAuth { /** * Required. The client identifier. */ clientId?: string | null; /** * Required. Input only. The client secret. */ clientSecret?: string | null; } /** * Configuration parameters for the Connector Reference auth provider. */ export interface Schema$ConnectorReferenceAuthProvider { /** * Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. */ authorizationDetails?: Array<{ [key: string]: any; }> | null; /** * Required. The name of the referenced connector. */ connector?: string | null; } /** * Configuration parameters for the Cross-App Access auth provider. */ export interface Schema$CrossAppAccessAuthProvider { /** * Optional. Additional parameters to be passed to the token endpoint. */ additionalParameters?: { [key: string]: string; } | null; /** * Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. */ clientAssertionJwtAuth?: Schema$ClientAssertionJwtAuth; /** * Option 1: Authenticate using a standard `client_id` and `client_secret`. */ clientSecretAuth?: Schema$ClientSecretAuth; /** * Configuration when using a custom or third-party authorization server as the issuer. */ customIssuer?: Schema$CustomIssuer; /** * Configuration when using Google Accounts as the issuer. */ googleAccount?: Schema$GoogleAccount; /** * Configuration for when the input is already an ID-JAG. */ idJagInput?: Schema$DirectIdJagInput; /** * Configuration for when the input is an ID token. */ idTokenInput?: Schema$IdTokenProcessingConfig; /** * Configuration when using Workforce Identity Federation as the issuer. */ workforceIdentityFederation?: Schema$WorkforceIdentityFederation; } /** * Configuration for a custom or third-party authorization server issuer. */ export interface Schema$CustomIssuer { /** * Optional. The issuer identifier of the target Authorization Server. */ issuer?: string | null; /** * Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. */ tokenUrl?: string | null; } /** * Marker message indicating the input is already an ID-JAG, so no fetching is required. */ export interface Schema$DirectIdJagInput { } /** * Request message for `DisableAuthProvider`. */ export interface Schema$DisableAuthProviderRequest { /** * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; } /** * 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); \} */ export interface Schema$Empty { } /** * Request message for `EnableAuthProvider`. */ export interface Schema$EnableAuthProviderRequest { /** * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; } /** * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } /** * Configuration for Gemini Enterprise authentication. */ export interface Schema$GeminiEnterpriseAuthProviderParams { } /** * Configuration for Google Account usage as the issuer. */ export interface Schema$GoogleAccount { } /** * Defines how to process an input ID token to obtain an ID-JAG. */ export interface Schema$IdTokenProcessingConfig { /** * Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. */ agentIdentityPool?: Schema$AgentIdentityPool; /** * Optional. Optional additional claims to include when fetching an ID-JAG. */ idJagAdditionalClaims?: { [key: string]: any; } | null; /** * The resource name of the ID-JAG auth provider. Format: "projects/{project\}/locations/{location\}/authProviders/{auth_provider\}" */ idJagAuthProvider?: string | null; } /** * Response message for `ListAccessSummaries`. */ export interface Schema$ListAccessSummariesResponse { /** * The list of access summaries. */ accessSummaries?: Schema$AccessSummary[]; /** * A token identifying a page of results the server should return. */ nextPageToken?: string | null; /** * Unordered list. Locations that could not be reached. */ unreachable?: string[] | null; } /** * Response message for `ListAuthorizations`. */ export interface Schema$ListAuthorizationsResponse { /** * The list of authorizations. */ authorizations?: Schema$Authorization[]; /** * A token identifying a page of results the server should return. */ nextPageToken?: string | null; /** * Unordered list. Locations that could not be reached. */ unreachable?: string[] | null; } /** * Response message for `ListAuthProviders`. */ export interface Schema$ListAuthProvidersResponse { /** * The list of auth providers. */ authProviders?: Schema$AuthProvider[]; /** * A token identifying a page of results the server should return. */ nextPageToken?: string | null; /** * Unordered list. Locations that could not be reached. */ unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. */ export interface Schema$ListLocationsResponse { /** * A list of locations that matches the specified filter in the request. */ locations?: Schema$Location[]; /** * The standard List next-page token. */ nextPageToken?: string | null; } /** * A resource that represents a Google Cloud location. */ export interface Schema$Location { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string | null; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} */ labels?: { [key: string]: string; } | null; /** * The canonical id for this location. For example: `"us-east1"`. */ locationId?: string | null; /** * Service-specific metadata. For example the available capacity at the given location. */ metadata?: { [key: string]: any; } | null; /** * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string | null; } /** * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** * Specifies cloud audit logging configuration for this policy. */ auditConfigs?: Schema$AuditConfig[]; /** * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. */ bindings?: Schema$Binding[]; /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } /** * Response message for `QueryAuthProviders`. */ export interface Schema$QueryAuthProvidersResponse { /** * The unique list of auth provider resource names used by the workload. */ authProviderNames?: string[] | null; /** * A token identifying a page of results the server should return. If this field is omitted, there are no subsequent pages. */ nextPageToken?: string | null; } /** * Response message for `QueryWorkloads`. */ export interface Schema$QueryWorkloadsResponse { /** * A token to retrieve the next page of results. */ nextPageToken?: string | null; /** * The unique list of identifiers for the agents that used this auth provider, starting with `principal://`. */ workloadIds?: string[] | null; } /** * Request message for `ResolveAuthorization`. */ export interface Schema$ResolveAuthorizationRequest { /** * Required. The user ID of the client for whom the authorization is resolved. */ clientUserId?: string | null; } /** * Response message for `ResolveAuthorization`. */ export interface Schema$ResolveAuthorizationResponse { /** * The resource name of the resolved authorization. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\}/authorizations/{authorization\} */ authorization?: string | null; } /** * Request message for `RevokeAuthorization`. */ export interface Schema$RevokeAuthorizationRequest { /** * Required. The identity of the user to revoke authorization for. */ userId?: string | null; } /** * Response message for `RevokeAuthorization`. */ export interface Schema$RevokeAuthorizationResponse { } /** * Request message for `SetIamPolicy` method. */ export interface Schema$SetIamPolicyRequest { /** * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. */ policy?: Schema$Policy; /** * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } /** * Request message for `TestIamPermissions` method. */ export interface Schema$TestIamPermissionsRequest { /** * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[] | null; } /** * Response message for `TestIamPermissions` method. */ export interface Schema$TestIamPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[] | null; } /** * Configuration for 3-legged OAuth (3LO) authentication. */ export interface Schema$ThreeLeggedOAuth { /** * Optional. The authorization endpoint to send users to for consenting to delegate to the agent. For example, "https://auth.atlassian.com/authorize". */ authorizationUrl?: string | null; /** * Optional. The client ID of the OAuth client. */ clientId?: string | null; /** * Optional. Input only. The client secret of the OAuth client. */ clientSecret?: string | null; /** * Optional. The default continue URI for the 3LO flow, used when no continue URI is provided in the RetrieveCredentials request. */ defaultContinueUri?: string | null; /** * Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks. */ enablePkce?: boolean | null; /** * Output only. The redirect URL this auth provider uses for the OAuth exchange. This is deterministic based on the name of the auth provider. */ redirectUrl?: string | null; /** * Optional. The token endpoint for requesting tokens on behalf of an end user. For example, "https://auth.atlassian.com/oauth/token". */ tokenUrl?: string | null; } /** * Configuration for 2-legged OAuth (2LO) authentication. */ export interface Schema$TwoLeggedOAuth { /** * Optional. The client ID of the OAuth client. */ clientId?: string | null; /** * Optional. Input only. The client secret of the OAuth client. */ clientSecret?: string | null; /** * Optional. The token endpoint of the OAuth client. */ tokenUrl?: string | null; } /** * Request message for `UndeleteAuthProvider`. */ export interface Schema$UndeleteAuthProviderRequest { /** * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; } /** * Configuration for Workforce Identity Federation usage as the issuer. */ export interface Schema$WorkforceIdentityFederation { } export class Resource$Projects { context: APIRequestContext; locations: Resource$Projects$Locations; constructor(context: APIRequestContext); } export class Resource$Projects$Locations { context: APIRequestContext; accessSummaries: Resource$Projects$Locations$Accesssummaries; authProviders: Resource$Projects$Locations$Authproviders; constructor(context: APIRequestContext); /** * Gets information about a location. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.get({ * // Resource name for the location. * name: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { * // "displayName": "my_displayName", * // "labels": {}, * // "locationId": "my_locationId", * // "metadata": {}, * // "name": "my_name" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions): Promise>; get(params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions): Promise>; get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.list({ * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', * // The resource that owns the locations collection, if applicable. * name: 'projects/my-project', * // The maximum number of results to return. If not set, the service selects a default. * pageSize: 'placeholder-value', * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "locations": [], * // "nextPageToken": "my_nextPageToken" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions): Promise>; list(params?: Params$Resource$Projects$Locations$List, options?: MethodOptions): Promise>; list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } export interface Params$Resource$Projects$Locations$Get extends StandardParameters { /** * Resource name for the location. */ name?: string; } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** * The resource that owns the locations collection, if applicable. */ name?: string; /** * The maximum number of results to return. If not set, the service selects a default. */ pageSize?: number; /** * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */ pageToken?: string; } export class Resource$Projects$Locations$Accesssummaries { context: APIRequestContext; constructor(context: APIRequestContext); /** * Gets details of a single access summary. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.accessSummaries.get({ * // Required. The resource name of the access summary. * name: 'projects/my-project/locations/my-location/accessSummaries/my-accessSummarie', * }); * console.log(res.data); * * // Example response * // { * // "authProvider": "my_authProvider", * // "authProviderType": "my_authProviderType", * // "firstAccessTime": "my_firstAccessTime", * // "labels": {}, * // "lastAccessTime": "my_lastAccessTime", * // "name": "my_name", * // "purgeTime": "my_purgeTime", * // "scopes": [], * // "tokenUrl": "my_tokenUrl", * // "userId": "my_userId", * // "workloadId": "my_workloadId" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ get(params: Params$Resource$Projects$Locations$Accesssummaries$Get, options: StreamMethodOptions): Promise>; get(params?: Params$Resource$Projects$Locations$Accesssummaries$Get, options?: MethodOptions): Promise>; get(params: Params$Resource$Projects$Locations$Accesssummaries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Accesssummaries$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Accesssummaries$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * Lists access summaries in a given project and location. Supported filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id="spiffe://example.com/ns/default/sa/my-agent"` * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.accessSummaries.list({ * // Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=""` or `auth_provider_name=""` * filter: 'placeholder-value', * // Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order. * orderBy: 'placeholder-value', * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. * pageSize: 'placeholder-value', * // Optional. A token identifying a page of results the server should return. * pageToken: 'placeholder-value', * // Required. The parent resource where the search is performed. Format: projects/{project\}/locations/{location\} * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { * // "accessSummaries": [], * // "nextPageToken": "my_nextPageToken", * // "unreachable": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ list(params: Params$Resource$Projects$Locations$Accesssummaries$List, options: StreamMethodOptions): Promise>; list(params?: Params$Resource$Projects$Locations$Accesssummaries$List, options?: MethodOptions): Promise>; list(params: Params$Resource$Projects$Locations$Accesssummaries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Accesssummaries$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Accesssummaries$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } export interface Params$Resource$Projects$Locations$Accesssummaries$Get extends StandardParameters { /** * Required. The resource name of the access summary. */ name?: string; } export interface Params$Resource$Projects$Locations$Accesssummaries$List extends StandardParameters { /** * Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=""` or `auth_provider_name=""` */ filter?: string; /** * Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order. */ orderBy?: string; /** * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. */ pageSize?: number; /** * Optional. A token identifying a page of results the server should return. */ pageToken?: string; /** * Required. The parent resource where the search is performed. Format: projects/{project\}/locations/{location\} */ parent?: string; } export class Resource$Projects$Locations$Authproviders { context: APIRequestContext; authorizations: Resource$Projects$Locations$Authproviders$Authorizations; constructor(context: APIRequestContext); /** * Creates a new auth provider in a given project and location. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.create({ * // Required. The ID to use for the auth provider, which will become the final segment of the auth provider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. * authProviderId: 'placeholder-value', * // Required. The parent resource where the auth provider is created. Format: projects/{project\}/locations/{location\} * parent: 'projects/my-project/locations/my-location', * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "allowedScopes": [], * // "authProviderTypeParams": {}, * // "blockedScopes": [], * // "createTime": "my_createTime", * // "deleted": false, * // "description": "my_description", * // "expireTime": "my_expireTime", * // "labels": {}, * // "name": "my_name", * // "state": "my_state", * // "updateTime": "my_updateTime", * // "workloadIds": [] * // } * }, * }); * console.log(res.data); * * // Example response * // { * // "allowedScopes": [], * // "authProviderTypeParams": {}, * // "blockedScopes": [], * // "createTime": "my_createTime", * // "deleted": false, * // "description": "my_description", * // "expireTime": "my_expireTime", * // "labels": {}, * // "name": "my_name", * // "state": "my_state", * // "updateTime": "my_updateTime", * // "workloadIds": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ create(params: Params$Resource$Projects$Locations$Authproviders$Create, options: StreamMethodOptions): Promise>; create(params?: Params$Resource$Projects$Locations$Authproviders$Create, options?: MethodOptions): Promise>; create(params: Params$Resource$Projects$Locations$Authproviders$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Locations$Authproviders$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Locations$Authproviders$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * Deletes a single auth provider. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.delete({ * // Required. The resource name of the auth provider. * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // {} * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ delete(params: Params$Resource$Projects$Locations$Authproviders$Delete, options: StreamMethodOptions): Promise>; delete(params?: Params$Resource$Projects$Locations$Authproviders$Delete, options?: MethodOptions): Promise>; delete(params: Params$Resource$Projects$Locations$Authproviders$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Locations$Authproviders$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Locations$Authproviders$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * Disables a single auth provider. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.disable({ * // Required. The resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "requestId": "my_requestId" * // } * }, * }); * console.log(res.data); * * // Example response * // { * // "allowedScopes": [], * // "authProviderTypeParams": {}, * // "blockedScopes": [], * // "createTime": "my_createTime", * // "deleted": false, * // "description": "my_description", * // "expireTime": "my_expireTime", * // "labels": {}, * // "name": "my_name", * // "state": "my_state", * // "updateTime": "my_updateTime", * // "workloadIds": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ disable(params: Params$Resource$Projects$Locations$Authproviders$Disable, options: StreamMethodOptions): Promise>; disable(params?: Params$Resource$Projects$Locations$Authproviders$Disable, options?: MethodOptions): Promise>; disable(params: Params$Resource$Projects$Locations$Authproviders$Disable, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; disable(params: Params$Resource$Projects$Locations$Authproviders$Disable, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; disable(params: Params$Resource$Projects$Locations$Authproviders$Disable, callback: BodyResponseCallback): void; disable(callback: BodyResponseCallback): void; /** * Enables a single auth provider. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.enable({ * // Required. The resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "requestId": "my_requestId" * // } * }, * }); * console.log(res.data); * * // Example response * // { * // "allowedScopes": [], * // "authProviderTypeParams": {}, * // "blockedScopes": [], * // "createTime": "my_createTime", * // "deleted": false, * // "description": "my_description", * // "expireTime": "my_expireTime", * // "labels": {}, * // "name": "my_name", * // "state": "my_state", * // "updateTime": "my_updateTime", * // "workloadIds": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ enable(params: Params$Resource$Projects$Locations$Authproviders$Enable, options: StreamMethodOptions): Promise>; enable(params?: Params$Resource$Projects$Locations$Authproviders$Enable, options?: MethodOptions): Promise>; enable(params: Params$Resource$Projects$Locations$Authproviders$Enable, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; enable(params: Params$Resource$Projects$Locations$Authproviders$Enable, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; enable(params: Params$Resource$Projects$Locations$Authproviders$Enable, callback: BodyResponseCallback): void; enable(callback: BodyResponseCallback): void; /** * Gets details of a single auth provider. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.get({ * // Required. The resource name of the auth provider. * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * }); * console.log(res.data); * * // Example response * // { * // "allowedScopes": [], * // "authProviderTypeParams": {}, * // "blockedScopes": [], * // "createTime": "my_createTime", * // "deleted": false, * // "description": "my_description", * // "expireTime": "my_expireTime", * // "labels": {}, * // "name": "my_name", * // "state": "my_state", * // "updateTime": "my_updateTime", * // "workloadIds": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ get(params: Params$Resource$Projects$Locations$Authproviders$Get, options: StreamMethodOptions): Promise>; get(params?: Params$Resource$Projects$Locations$Authproviders$Get, options?: MethodOptions): Promise>; get(params: Params$Resource$Projects$Locations$Authproviders$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Authproviders$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Authproviders$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.getIamPolicy( * { * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. * resource: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * }, * ); * console.log(res.data); * * // Example response * // { * // "auditConfigs": [], * // "bindings": [], * // "etag": "my_etag", * // "version": 0 * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Getiampolicy, options: StreamMethodOptions): Promise>; getIamPolicy(params?: Params$Resource$Projects$Locations$Authproviders$Getiampolicy, options?: MethodOptions): Promise>; getIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Getiampolicy, callback: BodyResponseCallback): void; getIamPolicy(callback: BodyResponseCallback): void; /** * Lists auth providers in a given project and location. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.list({ * // Optional. Filter results. This field is currently ignored. * filter: 'placeholder-value', * // Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order. * orderBy: 'placeholder-value', * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. * pageSize: 'placeholder-value', * // Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. * pageToken: 'placeholder-value', * // Required. The parent resource where the search is performed. Format: projects/{project\}/locations/{location\} * parent: 'projects/my-project/locations/my-location', * // Optional. Deleted auth providers will be kept with a soft-delete for 30 days before being purged. If this field is set to `true`, deleted auth providers will also be returned. * showDeleted: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "authProviders": [], * // "nextPageToken": "my_nextPageToken", * // "unreachable": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ list(params: Params$Resource$Projects$Locations$Authproviders$List, options: StreamMethodOptions): Promise>; list(params?: Params$Resource$Projects$Locations$Authproviders$List, options?: MethodOptions): Promise>; list(params: Params$Resource$Projects$Locations$Authproviders$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Authproviders$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Authproviders$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * Updates the parameters of a single auth provider. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.patch({ * // Identifier. The full resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * // Optional. Field mask is used to specify the fields to be overwritten in the auth provider resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "allowedScopes": [], * // "authProviderTypeParams": {}, * // "blockedScopes": [], * // "createTime": "my_createTime", * // "deleted": false, * // "description": "my_description", * // "expireTime": "my_expireTime", * // "labels": {}, * // "name": "my_name", * // "state": "my_state", * // "updateTime": "my_updateTime", * // "workloadIds": [] * // } * }, * }); * console.log(res.data); * * // Example response * // { * // "allowedScopes": [], * // "authProviderTypeParams": {}, * // "blockedScopes": [], * // "createTime": "my_createTime", * // "deleted": false, * // "description": "my_description", * // "expireTime": "my_expireTime", * // "labels": {}, * // "name": "my_name", * // "state": "my_state", * // "updateTime": "my_updateTime", * // "workloadIds": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ patch(params: Params$Resource$Projects$Locations$Authproviders$Patch, options: StreamMethodOptions): Promise>; patch(params?: Params$Resource$Projects$Locations$Authproviders$Patch, options?: MethodOptions): Promise>; patch(params: Params$Resource$Projects$Locations$Authproviders$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Projects$Locations$Authproviders$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Projects$Locations$Authproviders$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * Queries which auth providers are used by a given workload ID. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.query({ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. * pageSize: 'placeholder-value', * // Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token. * pageToken: 'placeholder-value', * // Required. The parent resource where the search is performed. Format: projects/{project\}/locations/{location\} * parent: 'projects/my-project/locations/my-location', * // Required. The workload identifier to filter by. * workloadId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "authProviderNames": [], * // "nextPageToken": "my_nextPageToken" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ query(params: Params$Resource$Projects$Locations$Authproviders$Query, options: StreamMethodOptions): Promise>; query(params?: Params$Resource$Projects$Locations$Authproviders$Query, options?: MethodOptions): Promise>; query(params: Params$Resource$Projects$Locations$Authproviders$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; query(params: Params$Resource$Projects$Locations$Authproviders$Query, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; query(params: Params$Resource$Projects$Locations$Authproviders$Query, callback: BodyResponseCallback): void; query(callback: BodyResponseCallback): void; /** * Queries which workloads are using a given auth provider. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.queryWorkloads({ * // Required. The name of the auth provider to query. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. * pageSize: 'placeholder-value', * // Optional. A token, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to `QueryWorkloads` must match the call that provided the page token. If this field is omitted, the first page is returned. * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", * // "workloadIds": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ queryWorkloads(params: Params$Resource$Projects$Locations$Authproviders$Queryworkloads, options: StreamMethodOptions): Promise>; queryWorkloads(params?: Params$Resource$Projects$Locations$Authproviders$Queryworkloads, options?: MethodOptions): Promise>; queryWorkloads(params: Params$Resource$Projects$Locations$Authproviders$Queryworkloads, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; queryWorkloads(params: Params$Resource$Projects$Locations$Authproviders$Queryworkloads, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; queryWorkloads(params: Params$Resource$Projects$Locations$Authproviders$Queryworkloads, callback: BodyResponseCallback): void; queryWorkloads(callback: BodyResponseCallback): void; /** * Resolves an authorization for a user on an auth provider, creating one if it does not exist or returning an existing one. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.resolveAuthorization({ * // Required. The name of the auth provider to resolve authorization for. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "clientUserId": "my_clientUserId" * // } * }, * }); * console.log(res.data); * * // Example response * // { * // "authorization": "my_authorization" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ resolveAuthorization(params: Params$Resource$Projects$Locations$Authproviders$Resolveauthorization, options: StreamMethodOptions): Promise>; resolveAuthorization(params?: Params$Resource$Projects$Locations$Authproviders$Resolveauthorization, options?: MethodOptions): Promise>; resolveAuthorization(params: Params$Resource$Projects$Locations$Authproviders$Resolveauthorization, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; resolveAuthorization(params: Params$Resource$Projects$Locations$Authproviders$Resolveauthorization, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; resolveAuthorization(params: Params$Resource$Projects$Locations$Authproviders$Resolveauthorization, callback: BodyResponseCallback): void; resolveAuthorization(callback: BodyResponseCallback): void; /** * Revokes all authorizations for a specific user on an auth provider. This deletes all authorization records associated with the user and auth provider, effectively revoking access across all agents. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.revokeAuthorization({ * // Required. The resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "userId": "my_userId" * // } * }, * }); * console.log(res.data); * * // Example response * // {} * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ revokeAuthorization(params: Params$Resource$Projects$Locations$Authproviders$Revokeauthorization, options: StreamMethodOptions): Promise>; revokeAuthorization(params?: Params$Resource$Projects$Locations$Authproviders$Revokeauthorization, options?: MethodOptions): Promise>; revokeAuthorization(params: Params$Resource$Projects$Locations$Authproviders$Revokeauthorization, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; revokeAuthorization(params: Params$Resource$Projects$Locations$Authproviders$Revokeauthorization, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; revokeAuthorization(params: Params$Resource$Projects$Locations$Authproviders$Revokeauthorization, callback: BodyResponseCallback): void; revokeAuthorization(callback: BodyResponseCallback): void; /** * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.setIamPolicy( * { * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. * resource: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "policy": {}, * // "updateMask": "my_updateMask" * // } * }, * }, * ); * console.log(res.data); * * // Example response * // { * // "auditConfigs": [], * // "bindings": [], * // "etag": "my_etag", * // "version": 0 * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Setiampolicy, options: StreamMethodOptions): Promise>; setIamPolicy(params?: Params$Resource$Projects$Locations$Authproviders$Setiampolicy, options?: MethodOptions): Promise>; setIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Setiampolicy, callback: BodyResponseCallback): void; setIamPolicy(callback: BodyResponseCallback): void; /** * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.testIamPermissions({ * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. * resource: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "permissions": [] * // } * }, * }); * console.log(res.data); * * // Example response * // { * // "permissions": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions(params: Params$Resource$Projects$Locations$Authproviders$Testiampermissions, options: StreamMethodOptions): Promise>; testIamPermissions(params?: Params$Resource$Projects$Locations$Authproviders$Testiampermissions, options?: MethodOptions): Promise>; testIamPermissions(params: Params$Resource$Projects$Locations$Authproviders$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Locations$Authproviders$Testiampermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Locations$Authproviders$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions(callback: BodyResponseCallback): void; /** * Undeletes a single auth provider. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await agentidentity.projects.locations.authProviders.undelete({ * // Required. The resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "requestId": "my_requestId" * // } * }, * }); * console.log(res.data); * * // Example response * // { * // "allowedScopes": [], * // "authProviderTypeParams": {}, * // "blockedScopes": [], * // "createTime": "my_createTime", * // "deleted": false, * // "description": "my_description", * // "expireTime": "my_expireTime", * // "labels": {}, * // "name": "my_name", * // "state": "my_state", * // "updateTime": "my_updateTime", * // "workloadIds": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ undelete(params: Params$Resource$Projects$Locations$Authproviders$Undelete, options: StreamMethodOptions): Promise>; undelete(params?: Params$Resource$Projects$Locations$Authproviders$Undelete, options?: MethodOptions): Promise>; undelete(params: Params$Resource$Projects$Locations$Authproviders$Undelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; undelete(params: Params$Resource$Projects$Locations$Authproviders$Undelete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; undelete(params: Params$Resource$Projects$Locations$Authproviders$Undelete, callback: BodyResponseCallback): void; undelete(callback: BodyResponseCallback): void; } export interface Params$Resource$Projects$Locations$Authproviders$Create extends StandardParameters { /** * Required. The ID to use for the auth provider, which will become the final segment of the auth provider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. */ authProviderId?: string; /** * Required. The parent resource where the auth provider is created. Format: projects/{project\}/locations/{location\} */ parent?: string; /** * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Request body metadata */ requestBody?: Schema$AuthProvider; } export interface Params$Resource$Projects$Locations$Authproviders$Delete extends StandardParameters { /** * Required. The resource name of the auth provider. */ name?: string; /** * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } export interface Params$Resource$Projects$Locations$Authproviders$Disable extends StandardParameters { /** * Required. The resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ name?: string; /** * Request body metadata */ requestBody?: Schema$DisableAuthProviderRequest; } export interface Params$Resource$Projects$Locations$Authproviders$Enable extends StandardParameters { /** * Required. The resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ name?: string; /** * Request body metadata */ requestBody?: Schema$EnableAuthProviderRequest; } export interface Params$Resource$Projects$Locations$Authproviders$Get extends StandardParameters { /** * Required. The resource name of the auth provider. */ name?: string; } export interface Params$Resource$Projects$Locations$Authproviders$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ resource?: string; } export interface Params$Resource$Projects$Locations$Authproviders$List extends StandardParameters { /** * Optional. Filter results. This field is currently ignored. */ filter?: string; /** * Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order. */ orderBy?: string; /** * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. */ pageSize?: number; /** * Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. */ pageToken?: string; /** * Required. The parent resource where the search is performed. Format: projects/{project\}/locations/{location\} */ parent?: string; /** * Optional. Deleted auth providers will be kept with a soft-delete for 30 days before being purged. If this field is set to `true`, deleted auth providers will also be returned. */ showDeleted?: boolean; } export interface Params$Resource$Projects$Locations$Authproviders$Patch extends StandardParameters { /** * Identifier. The full resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ name?: string; /** * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Optional. Field mask is used to specify the fields to be overwritten in the auth provider resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. */ updateMask?: string; /** * Request body metadata */ requestBody?: Schema$AuthProvider; } export interface Params$Resource$Projects$Locations$Authproviders$Query extends StandardParameters { /** * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. */ pageSize?: number; /** * Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token. */ pageToken?: string; /** * Required. The parent resource where the search is performed. Format: projects/{project\}/locations/{location\} */ parent?: string; /** * Required. The workload identifier to filter by. */ workloadId?: string; } export interface Params$Resource$Projects$Locations$Authproviders$Queryworkloads extends StandardParameters { /** * Required. The name of the auth provider to query. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ name?: string; /** * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. */ pageSize?: number; /** * Optional. A token, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to `QueryWorkloads` must match the call that provided the page token. If this field is omitted, the first page is returned. */ pageToken?: string; } export interface Params$Resource$Projects$Locations$Authproviders$Resolveauthorization extends StandardParameters { /** * Required. The name of the auth provider to resolve authorization for. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ name?: string; /** * Request body metadata */ requestBody?: Schema$ResolveAuthorizationRequest; } export interface Params$Resource$Projects$Locations$Authproviders$Revokeauthorization extends StandardParameters { /** * Required. The resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ name?: string; /** * Request body metadata */ requestBody?: Schema$RevokeAuthorizationRequest; } export interface Params$Resource$Projects$Locations$Authproviders$Setiampolicy extends StandardParameters { /** * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$SetIamPolicyRequest; } export interface Params$Resource$Projects$Locations$Authproviders$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$TestIamPermissionsRequest; } export interface Params$Resource$Projects$Locations$Authproviders$Undelete extends StandardParameters { /** * Required. The resource name of the auth provider. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ name?: string; /** * Request body metadata */ requestBody?: Schema$UndeleteAuthProviderRequest; } export class Resource$Projects$Locations$Authproviders$Authorizations { context: APIRequestContext; constructor(context: APIRequestContext); /** * Deletes a single authorization. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.authorizations.delete({ * // Required. The resource name of the authorization to delete. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\}/authorizations/{authorization\} * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider/authorizations/my-authorization', * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // {} * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ delete(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Delete, options: StreamMethodOptions): Promise>; delete(params?: Params$Resource$Projects$Locations$Authproviders$Authorizations$Delete, options?: MethodOptions): Promise>; delete(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * Gets details of a single authorization. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.authorizations.get({ * // Required. The resource name of the authorization. * name: 'projects/my-project/locations/my-location/authProviders/my-authProvider/authorizations/my-authorization', * }); * console.log(res.data); * * // Example response * // { * // "clientUserId": "my_clientUserId", * // "createTime": "my_createTime", * // "name": "my_name", * // "scopes": [], * // "state": "my_state", * // "updateTime": "my_updateTime" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ get(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Get, options: StreamMethodOptions): Promise>; get(params?: Params$Resource$Projects$Locations$Authproviders$Authorizations$Get, options?: MethodOptions): Promise>; get(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.authorizations.getIamPolicy( * { * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. * resource: * 'projects/my-project/locations/my-location/authProviders/my-authProvider/authorizations/my-authorization', * }, * ); * console.log(res.data); * * // Example response * // { * // "auditConfigs": [], * // "bindings": [], * // "etag": "my_etag", * // "version": 0 * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Getiampolicy, options: StreamMethodOptions): Promise>; getIamPolicy(params?: Params$Resource$Projects$Locations$Authproviders$Authorizations$Getiampolicy, options?: MethodOptions): Promise>; getIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Getiampolicy, callback: BodyResponseCallback): void; getIamPolicy(callback: BodyResponseCallback): void; /** * Lists authorizations in a given project and location. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.authorizations.list({ * // Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=""` * filter: 'placeholder-value', * // Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order. * orderBy: 'placeholder-value', * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. * pageSize: 'placeholder-value', * // Optional. A page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token. * pageToken: 'placeholder-value', * // Required. The parent resource where the search is performed. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} * parent: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * }); * console.log(res.data); * * // Example response * // { * // "authorizations": [], * // "nextPageToken": "my_nextPageToken", * // "unreachable": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ list(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$List, options: StreamMethodOptions): Promise>; list(params?: Params$Resource$Projects$Locations$Authproviders$Authorizations$List, options?: MethodOptions): Promise>; list(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.authorizations.setIamPolicy( * { * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. * resource: * 'projects/my-project/locations/my-location/authProviders/my-authProvider/authorizations/my-authorization', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "policy": {}, * // "updateMask": "my_updateMask" * // } * }, * }, * ); * console.log(res.data); * * // Example response * // { * // "auditConfigs": [], * // "bindings": [], * // "etag": "my_etag", * // "version": 0 * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Setiampolicy, options: StreamMethodOptions): Promise>; setIamPolicy(params?: Params$Resource$Projects$Locations$Authproviders$Authorizations$Setiampolicy, options?: MethodOptions): Promise>; setIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Setiampolicy, callback: BodyResponseCallback): void; setIamPolicy(callback: BodyResponseCallback): void; /** * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/agentidentity.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const agentidentity = google.agentidentity('v1alpha'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = * await agentidentity.projects.locations.authProviders.authorizations.testIamPermissions( * { * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. * resource: * 'projects/my-project/locations/my-location/authProviders/my-authProvider/authorizations/my-authorization', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "permissions": [] * // } * }, * }, * ); * console.log(res.data); * * // Example response * // { * // "permissions": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Testiampermissions, options: StreamMethodOptions): Promise>; testIamPermissions(params?: Params$Resource$Projects$Locations$Authproviders$Authorizations$Testiampermissions, options?: MethodOptions): Promise>; testIamPermissions(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Testiampermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Locations$Authproviders$Authorizations$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions(callback: BodyResponseCallback): void; } export interface Params$Resource$Projects$Locations$Authproviders$Authorizations$Delete extends StandardParameters { /** * Required. The resource name of the authorization to delete. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\}/authorizations/{authorization\} */ name?: string; /** * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } export interface Params$Resource$Projects$Locations$Authproviders$Authorizations$Get extends StandardParameters { /** * Required. The resource name of the authorization. */ name?: string; } export interface Params$Resource$Projects$Locations$Authproviders$Authorizations$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ resource?: string; } export interface Params$Resource$Projects$Locations$Authproviders$Authorizations$List extends StandardParameters { /** * Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=""` */ filter?: string; /** * Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order. */ orderBy?: string; /** * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. */ pageSize?: number; /** * Optional. A page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token. */ pageToken?: string; /** * Required. The parent resource where the search is performed. Format: projects/{project\}/locations/{location\}/authProviders/{auth_provider\} */ parent?: string; } export interface Params$Resource$Projects$Locations$Authproviders$Authorizations$Setiampolicy extends StandardParameters { /** * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$SetIamPolicyRequest; } export interface Params$Resource$Projects$Locations$Authproviders$Authorizations$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$TestIamPermissionsRequest; } export {}; }