Sign in
projects

Updates the parameters of a single auth provider.

patch/v1/{+name}

Request

  • Base URL: https://agentidentity.googleapis.com
  • URL: https://agentidentity.googleapis.com/v1/{+name}
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

namestring required

Identifier. The full resource name of the auth provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

Query parameters

requestIdstring

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).

updateMaskstring

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.

Request body

createTimestring google-datetime

Output only. The creation timestamp.

expireTimestring google-datetime

Output only. The time when the auth provider will expire.

namestring

Identifier. The full resource name of the auth provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

deletedboolean

Output only. Set to true if the auth provider is deleted.

blockedScopesstring[]

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.

state'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED'

Output only. The state of the auth provider.

updateTimestring google-datetime

Output only. The update timestamp.

allowedScopesstring[]

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.

descriptionstring

Optional. Description of the resource. Must be less than 256 characters.

labelsobject

Optional. Labels as key-value pairs.

workloadIdsstring[]

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}

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.