Sign in
latestOpenAPI 3.0.02026-08-1091020.6 KB

6db43b35bc50

well-known

sgID OpenID Provider Configuration Document

get/v2/.well-known/openid-configuration

Response

A JSON object representing a set of Claims about the sgID's configuration as an OpenID Provider

issuerstring

Issuer of ID Token

authorization_endpointstring

URL of the sgID's OAuth 2.0 Authorization Endpoint

token_endpointstring

URL of the sgID's OAuth 2.0 Token Endpoint

userinfo_endpointstring

URL of the sgID's UserInfo Endpoint

jwks_uristring

URL of the sgID's JSON Web Key Set document

response_types_supportedstring[]

JSON array containing a list of the OAuth 2.0 response_type values that sgID supports

grant_types_supportedstring[]

JSON array containing a list of the OAuth 2.0 Grant Type values that sgID supports

scopes_supportedstring[]

JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that sgID supports

id_token_signing_alg_values_supportedstring[]

JSON array containing a list of the JWS signing algorithms (alg values) supported by sgID for the ID Token to encode the Claims in a JWT

subject_types_supportedstring[]

JSON array containing a list of the Subject Identifier types that sgID supports

code_challenge_methods_supportedstring[]

JSON array containing a list of supported code challenge methods for PKCE

Example response

{
  "issuer": "https://api.id.gov.sg/v2",
  "authorization_endpoint": "https://api.id.gov.sg/v2/oauth/authorize",
  "token_endpoint": "https://api.id.gov.sg/v2/oauth/token",
  "userinfo_endpoint": "https://api.id.gov.sg/v2/oauth/userinfo",
  "jwks_uri": "https://api.id.gov.sg/v2/.well-known/jwks.json",
  "response_types_supported": [
    "code"
  ],
  "grant_types_supported": [
    "authorization_code"
  ],
  "scopes_supported": [
    "openid",
    "myinfo.nric_number",
    "myinfo.name"
  ],
  "id_token_signing_alg_values_supported": [
    "RS256"
  ],
  "subject_types_supported": [
    "pairwise"
  ],
  "code_challenge_methods_supported": [
    "S256"
  ]
}