OidcClientRegistrationRequest class

Client metadata for OAuth 2.0 Dynamic Client Registration (RFC 7591 §2), also used as the body of an RFC 7592 client update.

The JSON keys are the standard RFC 7591 client-metadata names. Any field not modelled here can be supplied via extra.

Annotations

• @JsonSerializable.new(createFactory: false, includeIfNull: false, explicitToJson: true, converters: OidcInternalUtilities.commonConverters)

Constructors

OidcClientRegistrationRequest({List<Uri>? redirectUris, List<Uri>? postLogoutRedirectUris, List<String>? responseTypes, List<String>? grantTypes, String? applicationType, List<String>? contacts, String? clientName, Uri? logoUri, Uri? clientUri, Uri? policyUri, Uri? tosUri, Uri? jwksUri, Map<String, dynamic>? jwks, Uri? sectorIdentifierUri, String? subjectType, String? tokenEndpointAuthMethod, String? idTokenSignedResponseAlg, Duration? defaultMaxAge, bool? requireAuthTime, List<String>? defaultAcrValues, Uri? initiateLoginUri, List<Uri>? requestUris, List<String>? scope, String? softwareId, String? softwareVersion, String? softwareStatement, String? tlsClientAuthSubjectDn, String? tlsClientAuthSanDns, String? tlsClientAuthSanUri, String? tlsClientAuthSanIp, String? tlsClientAuthSanEmail, bool? tlsClientCertificateBoundAccessTokens, Map<String, dynamic>? extra})

Properties

applicationType ↔ String?

Kind of the application: web or native.

getter/setter pair

clientName ↔ String?

Human-readable name of the client.

getter/setter pair

clientUri ↔ Uri?

URL of the client's home page.

getter/setter pair

contacts ↔ List<String>?

E-mail addresses of people responsible for the client.

getter/setter pair

defaultAcrValues ↔ List<String>?

Default acr values the OP is requested to use for this client (OpenID Connect Dynamic Client Registration 1.0 §2), as a JSON array of strings.

getter/setter pair

defaultMaxAge ↔ Duration?

Default Maximum Authentication Age (OpenID Connect Dynamic Client Registration 1.0 §2): if the End-User was authenticated longer ago than this, they MUST be actively re-authenticated. Serialized as a number of seconds.

getter/setter pair

extra → Map<String, dynamic>

Extra parameters to add to the request.

final, inherited

grantTypes ↔ List<String>?

OAuth 2.0 grant types the client may use.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

idTokenSignedResponseAlg ↔ String?

JWS alg the client requires for its id_tokens.

getter/setter pair

initiateLoginUri ↔ Uri?

URI (https) a third party can use to initiate a login for this client (OpenID Connect Dynamic Client Registration 1.0 §2).

getter/setter pair

jwks ↔ Map<String, dynamic>?

The client's JWK Set by value (mutually exclusive with jwksUri).

getter/setter pair

jwksUri ↔ Uri?

URL of the client's JWK Set document.

getter/setter pair

logoUri ↔ Uri?

URL of the client's logo.

getter/setter pair

policyUri ↔ Uri?

URL of the client's privacy policy.

getter/setter pair

postLogoutRedirectUris ↔ List<Uri>?

Post-logout redirection URI values used by the client (OpenID Connect RP-Initiated Logout 1.0 §3), which requires the post_logout_redirect_uri sent to the end_session_endpoint to have been registered here.

getter/setter pair

redirectUris ↔ List<Uri>?

Redirection URI values used by the client.

getter/setter pair

requestUris ↔ List<Uri>?

request_uri values pre-registered by the client for use at the OP (OpenID Connect Dynamic Client Registration 1.0 §2). These URIs MUST use the https scheme.

getter/setter pair

requireAuthTime ↔ bool?

Whether the auth_time claim in the id_token is REQUIRED (OpenID Connect Dynamic Client Registration 1.0 §2).

getter/setter pair

responseTypes ↔ List<String>?

OAuth 2.0 response types the client may use.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scope ↔ List<String>?

Space-separated list of scope values the client may request.

getter/setter pair

sectorIdentifierUri ↔ Uri?

URL referencing the client's sector identifier.

getter/setter pair

softwareId ↔ String?

Unique identifier for the client software (constant across instances).

getter/setter pair

softwareStatement ↔ String?

A signed software statement JWT asserting client metadata.

getter/setter pair

softwareVersion ↔ String?

Version of the client software.

getter/setter pair

subjectType ↔ String?

subject_type requested for responses to this client.

getter/setter pair

tlsClientAuthSanDns ↔ String?

RFC 8705 §2.1.2: expected dNSName SAN entry of the client certificate, for the tls_client_auth PKI method.

getter/setter pair

tlsClientAuthSanEmail ↔ String?

RFC 8705 §2.1.2: expected rfc822Name SAN entry of the client certificate, for the tls_client_auth PKI method.

getter/setter pair

tlsClientAuthSanIp ↔ String?

RFC 8705 §2.1.2: expected iPAddress SAN entry (dotted-decimal IPv4 or colon-delimited hexadecimal IPv6) of the client certificate, for the tls_client_auth PKI method.

getter/setter pair

tlsClientAuthSanUri ↔ String?

RFC 8705 §2.1.2: expected uniformResourceIdentifier SAN entry of the client certificate, for the tls_client_auth PKI method.

getter/setter pair

tlsClientAuthSubjectDn ↔ String?

RFC 8705 §2.1.2: expected subject distinguished name (RFC 4514 string) of the client certificate, for the tls_client_auth PKI method.

getter/setter pair

tlsClientCertificateBoundAccessTokens ↔ bool?

RFC 8705 §3.4: the client's intention to use mutual-TLS client certificate-bound access tokens.

getter/setter pair

tokenEndpointAuthMethod ↔ String?

Requested client authentication method for the token endpoint.

getter/setter pair

tosUri ↔ Uri?

URL of the client's terms of service.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator []=(String key, dynamic value) → void

inherited