Sign in
projects

Retrieves authorization credentials for an auth provider, or indicates what action needs to be taken to obtain credentials. If the token field in the response is populated, credential retrieval was successful. If one of the fields in the result oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on RetrieveCredentialsResponse for more information.

post/v1/{+authProvider}/credentials:retrieve

Request

  • Base URL: https://agentidentitycredentials.googleapis.com
  • URL: https://agentidentitycredentials.googleapis.com/v1/{+authProvider}/credentials:retrieve
  • 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

authProviderstring required

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

Request body

scopesstring[]

Optional. The OAuth scopes required for this access.

forceRefreshTokenstring

Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Setting this field triggers a refresh of the access token with a stored refresh token, if possible, or a new consent flow.

userIdstring

Required. The identity of the end user.

continueUristring

Optional. The URI to redirect the user to after consent is completed. This field is required for auth providers using the 3-legged OAuth flow. For other auth provider types, this field is unused but not rejected.

Response

Successful response

Changes