Obtain Third-party Authorization Information

POST 
/auth/v1/provider/token

resource_exhausted User requests exceed the frequency limit invalid_client The client does not exist failed_precondition Failed to obtain third-party information

Request

application/json

Body

required

provider_id string
provider_redirect_uri string
provider_code Either provider_code or one of provider_access_token/provider_id_token can be selected. By default, if provider_access_token is not empty, the provider_access_token mechanism will be used. (string)
provider_access_token string
provider_id_token string
provider_params object
property name* string

Responses

200

A successful response.

application/json

Schema

Schema

provider_token If auto-registration is not enabled, returns provider_token for further processing, e.g., via mobile number (string)
expires_in int32
provider_profile object
provider_id string
sub Primary ID (string)
name string
picture string
email string
phone_number string
gender string
locale string
url string
groups string[]
organization_id string
departments string[]
sub_id sub_id If SLO is required, sub_id may need to be returned. Reference: urn:oasis:names:tc:SAML:attribute:subject-id (string)
token Token returned by provider, e.g., refresh_token in OAuth mode (string)
at_hash at hash of provider profile (string)
meta object
property name* string
raw Raw information from third party (string)
provider string

Example (from schema)

{
  "provider_token": "string",
  "expires_in": 0,
  "provider_profile": {
    "provider_id": "string",
    "sub": "string",
    "name": "string",
    "picture": "string",
    "email": "string",
    "phone_number": "string",
    "gender": "string",
    "locale": "string",
    "url": "string",
    "groups": [
      "string"
    ],
    "organization_id": "string",
    "departments": [
      "string"
    ],
    "sub_id": "string",
    "token": "string",
    "at_hash": "string",
    "meta": {},
    "raw": "string",
    "provider": "string"
  }
}

401

the oauth2.0 access token is not correct or expired

application/json

Schema

Schema

any

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...