Skip to content

Latest commit

 

History

History
211 lines (177 loc) · 5.84 KB

passport-api.md

File metadata and controls

211 lines (177 loc) · 5.84 KB
Raw
description
Auth Gateway

Passport API

Exchange Token

Call this method to exchange an exchange code or refresh token for a new access token and refresh token.

{% swagger method="post" path="" baseUrl="https://passport.rollup.id/token" summary="Exchange Token" %} {% swagger-description %} Call this method to exchange an exchange code or refresh token for a new access token and refresh token. {% endswagger-description %}

{% swagger-parameter in="body" name="code" type="String" required="true" %} Exchange code {% endswagger-parameter %}

{% swagger-parameter in="body" name="client_id" required="true" %} Application client id {% endswagger-parameter %}

{% swagger-parameter in="body" name="client_secret" type="String" required="true" %} Application client secret {% endswagger-parameter %}

{% swagger-parameter in="body" name="grant_type" type="String" required="true" %} "authorization_code" or "refresh_token" {% endswagger-parameter %}

{% swagger-response status="201: Created" description="Exchange token response" %}

{
    access_token: string,
    refresh_token: string,
    token_type: 'Bearer',
    id_token: string
}

{% endswagger-response %} {% endswagger %}

Example

{% tabs %} {% tab title="Javascript" %}

const tokenForm = new Form()
tokenForm.append('code', exchangeCode)
tokenForm.append('grant_type', grantType)
tokenForm.append('client_id', clientId)
tokenForm.append('client_secret', clientSecret)

const { access_code, refresh_token } = await fetch(
  'https://passport.rollup.id/token',
  {
    method: 'post',
    body: tokenForm,
  }
)

{% endtab %}

{% tab title="Curl" %}

curl https://passport.rollup.id/token -X POST \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "client_id={clientId}" \
  --data-urlencode "client_secret={clientSecret}"
  --data-urlencode "code={exchangeCode}"
  --data-urlencode "grant_type=authorization_code"

{% endtab %} {% endtabs %}

Source

https://github.com/proofzero/rollupid/blob/main/apps/passport/app/routes/token.tsx

User Info

Call this method to retrieve basic identity information for the user. This endpoint retrieves fresh data that would have been included in the ID token when the app was initially authorized by the user.

{% swagger method="post" path="userinfo" baseUrl="https://passport.rollup.id/" summary="User Info" %} {% swagger-description %} Call this method to retrieve basic identity information for the user. {% endswagger-description %}

{% swagger-parameter in="header" name="Authorization" type="String" required="true" %} Bearer {access token} {% endswagger-parameter %}

{% swagger-response status="200: OK" description="User Info response" %}

{
    name: '(some name here)',
    picture: '(URL of some picture here)',
    email: '(email address connected to the account)',
    sub: '(unique identifier of the account aka. accountURN)',
    connected_accounts: [
      {
        type: 'eth',
        identifier: '(eth address)'
      },
      {
        type: 'email',
        identifier: '(email address of connected account)'
      },
      {
        type: 'github',
        identifier: '(github username)'
      }
      //other addresses
    ]
}

{% endswagger-response %} {% endswagger %}

Example

{% tabs %} {% tab title="Javascript" %}

const access_token = '(some access token value)'

const response = await fetch('https://passport.rollup.id/userinfo', {
  headers: {
    Authorization: `Bearer ${access_token}`,
  },
})
const { name, picture } = await response.json()

{% endtab %}

{% tab title="Curl" %}

export token="(some token value)"
curl https://passport.rollup.id/userinfo \
  --header "Authorization: Bearer $token"

{% endtab %} {% endtabs %}

OpenID Connect Discovery

The OpenID provider metadata can be accessed in the endpoint described below.

{% swagger method="get" path="" baseUrl="https://passport.rollup.id/.well-known/openid-configuration" summary="OpenID Configuration" %} {% swagger-description %}

{% endswagger-description %}

{% swagger-response status="200: OK" description="OpenID Configuration" %}

{
  "issuer": "https://passport.rollup.id",
  "authorization_endpoint": "https://passport.rollup.id/authorize",
  "token_endpoint": "https://passport.rollup.id/token",
  "token_endpoint_auth_methods_supported": ["client_secret_post"],
  "token_endpoint_auth_signing_alg_values_supported": ["ES256"],
  "userinfo_endpoint": "https://passport.rollup.id/userinfo",
  "jwks_uri": "https://passport.rollup.id/.well-known/jwks.json",
  "scopes_supported": ["openid", "profile", "email"],
  "response_types_supported": ["code"],
  "subject_types_supported": ["public", "pairwise"],
  "userinfo_signing_alg_values_supported": ["ES256"],
  "id_token_signing_alg_values_supported": ["ES256"],
  "request_object_signing_alg_values_supported": ["ES256"],
  "claims_supported": ["sub", "iss"],
  "service_documentation": "https://docs.rollup.id/"
}

{% endswagger-response %} {% endswagger %}

JSON Web Key Set

The JWKS is the list of public keys to be used to validate token signatures.

{% swagger method="get" path="" baseUrl="https://passport.rollup.id/.well-known/jwks.json" summary="JWKS" %} {% swagger-description %}

{% endswagger-description %}

{% swagger-response status="200: OK" description="JWKS" %}

{
  "keys": [
    {
      "alg": "ES256",
      "kid": "1682004114895",
      "kty": "EC",
      "x": "ArcyYahTQbDLptozxzlYArNCKkz50iE7uCW1FBZ4P6Y",
      "y": "Vi51b0mBI1QWALTf5vd2guoBNn72VTv473vhHt1ZgQw",
      "crv": "P-256"
    },
    {
      "alg": "ES256",
      "kid": "1682000697502",
      "kty": "EC",
      "x": "JL5ZRnjb9pp9TqKsT5-pfa0Yw-Q191J210MwpdpWlZQ",
      "y": "OOc5DhoEIUczfNNof25suDFLWKNUTTb0pDm2_4hJMk4",
      "crv": "P-256"
    }
  ]
}

{% endswagger-response %} {% endswagger %}