issuer

Documentation

Overview

Package issuer contains models for representing an issuer's metadata.

Index

• type Claim
• type ClaimDisplay
• type CredentialDisplay
• type CredentialIssuer
• type CredentialIssuerDisplay
• type Logo
• type Metadata
• type SupportedCredential

Types

type Claim

type Claim struct {
	Displays []ClaimDisplay `json:"display,omitempty"`
}

Claim represents display data for a specific claim in (potentially) multiple locales. Each ClaimDisplay represents display data for a single locale.

type ClaimDisplay

type ClaimDisplay struct {
	Name   string `json:"name,omitempty"`
	Locale string `json:"locale,omitempty"`
}

ClaimDisplay represents display data for a specific claim for a single locale.

type CredentialDisplay

type CredentialDisplay struct {
	Name            string `json:"name,omitempty"`
	Locale          string `json:"locale,omitempty"`
	Logo            *Logo  `json:"logo,omitempty"`
	BackgroundColor string `json:"background_color,omitempty"`
	TextColor       string `json:"text_color,omitempty"`
}

CredentialDisplay represents display data for a credential as a whole. Display data for specific claims (e.g. first name, date of birth, etc) are represented by ClaimDisplays, which are in SupportedCredential.CredentialSubject (in the parent object above).

type CredentialIssuer

type CredentialIssuer struct {
	Displays []CredentialIssuerDisplay `json:"display,omitempty"`
}

CredentialIssuer represents display information about the issuer of some credential(s) for (potentially) multiple locales. Each Display represents display data for a single locale.

type CredentialIssuerDisplay

type CredentialIssuerDisplay struct {
	Name   string `json:"name,omitempty"`
	Locale string `json:"locale,omitempty"`
}

CredentialIssuerDisplay represents display information for the issuer of some credential(s) for a single locale.

type Logo

type Logo struct {
	URL     string `json:"url,omitempty"`
	AltText string `json:"alt_text,omitempty"`
}

Logo represents display information for a logo.

type Metadata

type Metadata struct {
	Issuer                    string                         `json:"issuer,omitempty"`
	AuthorizationEndpoint     string                         `json:"authorization_endpoint,omitempty"`
	TokenEndpoint             string                         `json:"token_endpoint,omitempty"`
	PushedAuthRequestEndpoint string                         `json:"pushed_authorization_request_endpoint,omitempty"`
	RequirePushedAuthRequests bool                           `json:"require_pushed_authorization_requests,omitempty"`
	CredentialEndpoint        string                         `json:"credential_endpoint,omitempty"`
	CredentialsSupported      map[string]SupportedCredential `json:"credentials_supported,omitempty"`
	CredentialIssuer          *CredentialIssuer              `json:"credential_issuer,omitempty"`
}

Metadata represents metadata about an issuer as obtained from their .well-known OpenID configuration.

type SupportedCredential

type SupportedCredential struct {
	Format                                string              `json:"format,omitempty"`
	Types                                 []string            `json:"types,omitempty"`
	CryptographicBindingsMethodsSupported []string            `json:"cryptographic_bindings_methods_supported,omitempty"`
	CryptographicSuitesSupported          []string            `json:"cryptographic_suites_supported,omitempty"`
	Displays                              []CredentialDisplay `json:"display,omitempty"`
	CredentialSubject                     map[string]Claim    `json:"credentialSubject,omitempty"`
}

SupportedCredential represents metadata about a credential type that a credential issuer can issue.