IanaClaimTypes Class
Abblix.Jwt
Abblix.Jwt
IanaClaimTypes Class
Provides constants for various JWT and OpenID Connect claim types. Includes both registered claim types and public claim types as defined in various standards. This classification helps in ensuring interoperability across different systems and services by adhering to a common set of identifiers for claims.
public static class IanaClaimTypes
Inheritance System.Object → IanaClaimTypes
Fields
IanaClaimTypes.AceProfile Field
Specifies the ACE profile a token is used with, indicating its application in constrained environments.
public const string AceProfile = "ace_profile";
Field Value
Remarks
This claim is significant in scenarios utilizing the Authentication and Authorization for Constrained Environments (ACE) framework, ensuring that tokens are applied in accordance with the specific requirements and constraints of the ACE profile in use.
IanaClaimTypes.Acr Field
Represents the Authentication Context Class Reference.
public const string Acr = "acr";
Field Value
Remarks
Used in OpenID Connect. This claim specifies the authentication context class that the authentication performed satisfied. It allows clients to request and services to assert the strength of an authentication process.
IanaClaimTypes.Act Field
Represents the actor in OAuth 2.0 token exchange.
public const string Act = "act";
Field Value
Remarks
This claim is used to indicate the party that the token represents, especially in delegation and impersonation scenarios, allowing APIs and services to verify the actual party making a request.
IanaClaimTypes.Address Field
Represents the user's postal address.
public const string Address = "address";
Field Value
Remarks
Used in OpenID Connect. This JSON structured claim contains components of the user's address such as street address, locality, region, postal code, and country.
IanaClaimTypes.Amr Field
Represents the Authentication Methods References.
public const string Amr = "amr";
Field Value
Remarks
Used in OpenID Connect. This claim is used to specify the authentication methods used in the authentication process. It provides transparency about how the authentication was performed, such as 'pwd' for password-based or 'mfa' for multi-factor authentication.
IanaClaimTypes.AtHash Field
Represents the hash of the access token issued.
public const string AtHash = "at_hash";
Field Value
Remarks
Used in OpenID Connect. This claim is included in the ID Token and is a hash of the access token, allowing the recipient to validate the integrity of the access token. It is particularly useful in implicit and authorization code flows.
IanaClaimTypes.Attest Field
Represents the attestation level in SHAKEN/STIR frameworks.
public const string Attest = "attest";
Field Value
Remarks
This claim is used within the SHAKEN/STIR framework for telecommunication services, indicating the level of attestation for the origin of a call, which aids in combating caller ID spoofing and fraud.
IanaClaimTypes.AtUseNbr Field
Indicates the number of API requests for which the access token can be used.
public const string AtUseNbr = "at_use_nbr";
Field Value
Remarks
This claim is used primarily in environments where token usage is tightly controlled and monitored, providing a mechanism for limiting the number of requests a token can authorize to enhance security and manage resource utilization.
IanaClaimTypes.Aud Field
Identifies the recipients that the JWT is intended for.
public const string Aud = "aud";
Field Value
Remarks
Defined in RFC 7519, Section 4.1.3. It is generally a case-sensitive string or an array of strings containing StringOrURI values. The audience claim ensures that the JWT is sent to the intended recipients.
IanaClaimTypes.AuthorizationDetails Field
JSON array representing the authorization requirements for a specific resource or set of resources.
public const string AuthorizationDetails = "authorization_details";
Field Value
Remarks
This claim is used in OAuth Rich Authorization Requests (RAR) to specify detailed authorization data for a transaction, enabling fine-grained access control and tailored authorization experiences.
IanaClaimTypes.AuthTime Field
Indicates the time when the authentication occurred.
public const string AuthTime = "auth_time";
Field Value
Remarks
Used in OpenID Connect. This claim is critical in scenarios where the application requires assurance about the moment of authentication, such as re-authentication or step-up authentication.
IanaClaimTypes.Azp Field
Represents the authorized party - the party to which the ID Token was issued.
public const string Azp = "azp";
Field Value
Remarks
Used in OpenID Connect. This claim is particularly useful in delegated scenarios to identify the party using the ID Token.
IanaClaimTypes.Birthdate Field
Represents the user's date of birth.
public const string Birthdate = "birthdate";
Field Value
Remarks
Used in OpenID Connect. This claim is for the user's birthdate, typically represented in the ISO 8601:2004 YYYY-MM-DD format.
IanaClaimTypes.Cdnicrit Field
Identifies critical claims within the CDNI claim set.
public const string Cdnicrit = "cdnicrit";
Field Value
Remarks
This claim is used to mark certain claims as critical within the context of CDNI, indicating that the JWT should be processed differently or not at all if these claims are not understood or cannot be fulfilled.
IanaClaimTypes.Cdniets Field
Expiration time setting for token renewal in CDNI.
public const string Cdniets = "cdniets";
Field Value
Remarks
This claim specifies the expiration time for a CDNI token, guiding the renewal process by indicating when a new token must be obtained to continue accessing CDNI content or services.
IanaClaimTypes.Cdniip Field
Represents an IP address in CDNI scenarios.
public const string Cdniip = "cdniip";
Field Value
Remarks
This claim is used to convey IP address information within CDNI, supporting operations such as tokenized redirection or content delivery optimizations based on geographical or network-based criteria.
IanaClaimTypes.Cdnistd Field
Depth of the signed token in CDNI.
public const string Cdnistd = "cdnistd";
Field Value
Remarks
This claim provides information on the depth or hierarchy level of a signed token within CDNI, potentially influencing content delivery paths or access control decisions based on the token's scope and applicability.
IanaClaimTypes.Cdnistt Field
Transport method for signed token renewal in CDNI.
public const string Cdnistt = "cdnistt";
Field Value
Remarks
This claim indicates the transport method to be used for renewing signed tokens in CDNI, ensuring secure and efficient token exchange mechanisms are employed for content delivery and interconnection services.
IanaClaimTypes.Cdniuc Field
Contains a URI in CDNI contexts.
public const string Cdniuc = "cdniuc";
Field Value
Remarks
This claim is utilized to reference specific resources or content within CDNI, allowing for dynamic content delivery configurations and optimizations based on the content identified by the URI.
IanaClaimTypes.Cdniv Field
Version of the claim set used in Content Delivery Network Interconnection (CDNI).
public const string Cdniv = "cdniv";
Field Value
Remarks
This claim facilitates interoperability in CDNI contexts by specifying the version of the claim set, ensuring that both the issuer and recipient of a JWT understand the structure and semantics of the claims contained within.
IanaClaimTypes.CHash Field
Represents the Code Hash Value.
public const string CHash = "c_hash";
Field Value
Remarks
Used in OpenID Connect. This claim is used in the ID Token to provide a hash of the authorization code. It ensures that the authorization code is bound to the ID Token, enhancing the security of the code exchange process.
IanaClaimTypes.ClientId Field
Represents the client identifier in OAuth 2.0 contexts.
public const string ClientId = "client_id";
Field Value
Remarks
Identifies the OAuth 2.0 client that requested the token, providing a mechanism for associating a token with a specific registered client application, critical for enforcing client-specific access policies.
IanaClaimTypes.Cnf Field
Represents confirmation methods used by the token.
public const string Cnf = "cnf";
Field Value
Remarks
Utilized in scenarios that require additional confirmation of token validity, such as DPoP (Demonstrating Proof of Possession). This claim helps in binding tokens to specific cryptographic keys.
IanaClaimTypes.Cnonce Field
Nonce provided by the Resource Server to the Authorization Server via the client, verifying token freshness.
public const string Cnonce = "cnonce";
Field Value
Remarks
This claim is used to ensure the freshness of a token in interactions between the Resource Server, the client, and the Authorization Server, mitigating against replay attacks by validating the uniqueness and timeliness of each token request.
IanaClaimTypes.Dest Field
Represents the destination identity in telecommunication protocols.
public const string Dest = "dest";
Field Value
Remarks
Useful in communication protocols to convey the intended recipient or destination of the communication, supporting routing, billing, and security measures.
IanaClaimTypes.Div Field
Contains information about a call that was diverted from its original destination.
public const string Div = "div";
Field Value
Remarks
This claim is used in telecommunications contexts to provide details about call diversions, aiding in the management and tracing of call flows and in the implementation of services that react to call redirection.
IanaClaimTypes.Email Field
Represents the user's preferred email address.
public const string Email = "email";
Field Value
Remarks
Used in OpenID Connect. This claim is for the user's preferred email. Note that this email address might not be unique.
IanaClaimTypes.EmailVerified Field
Represents whether the user's email address has been verified.
public const string EmailVerified = "email_verified";
Field Value
Remarks
Used in OpenID Connect as a boolean. True if the user's email address has been verified; otherwise false.
IanaClaimTypes.Entitlements Field
Represents specific entitlements or permissions granted to the subject.
public const string Entitlements = "entitlements";
Field Value
Remarks
This claim is used to specify granular permissions or entitlements granted to a subject, allowing for precise control over access rights and enabling fine-grained authorization policies.
IanaClaimTypes.Events Field
Represents specific security events or state changes.
public const string Events = "events";
Field Value
Remarks
Used in Security Event Tokens (SETs) to convey information about security-related events or changes, such as authentication events or configuration changes, aiding in security monitoring and response.
IanaClaimTypes.Exi Field
Lifetime of the token in seconds from the time the Resource Server first sees it, for devices with unsynchronized clocks.
public const string Exi = "exi";
Field Value
Remarks
This claim addresses challenges posed by devices with unsynchronized clocks by providing a relative measure of the token's validity, enhancing interoperability and security in distributed systems.
IanaClaimTypes.Exp Field
Specifies the expiration time on or after which the JWT must not be accepted for processing.
public const string Exp = "exp";
Field Value
Remarks
Defined in RFC 7519, Section 4.1.4. The "exp" claim is a NumericDate value. Use this claim to define the validity period of the JWT.
IanaClaimTypes.FamilyName Field
Represents the surname(s) or last name(s) of the user.
public const string FamilyName = "family_name";
Field Value
Remarks
Used in OpenID Connect. This claim focuses on the user's family name or surname(s), excluding middle names.
IanaClaimTypes.Gender Field
Represents the user's gender.
public const string Gender = "gender";
Field Value
Remarks
Used in OpenID Connect. This claim can be used to convey the user's gender. The value is not strictly defined and can vary based on the user's preference and the application's requirements.
IanaClaimTypes.GivenName Field
Represents the first or given name(s) of the user.
public const string GivenName = "given_name";
Field Value
Remarks
Used in OpenID Connect. This claim is intended to refer to the user's first name or given name(s). It allows for middle names if applicable.
IanaClaimTypes.Groups Field
Represents the groups that the subject belongs to, typically used in identity and access management.
public const string Groups = "groups";
Field Value
Remarks
This claim is used to convey group membership information, supporting group-based access control and enabling systems to make authorization decisions based on the groups a subject is associated with.
IanaClaimTypes.Iat Field
Indicates the time at which the JWT was issued.
public const string Iat = "iat";
Field Value
Remarks
Defined in RFC 7519, Section 4.1.6. The "iat" (Issued At) claim is a NumericDate value. This claim can be used to determine the age of the JWT.
IanaClaimTypes.Iss Field
Represents the principal (e.g., authorization server) that issued the JWT.
public const string Iss = "iss";
Field Value
Remarks
Defined in RFC 7519, Section 4.1.1. It is a case-sensitive string containing a StringOrURI value. Use this claim to identify the issuer of the JWT uniquely.
IanaClaimTypes.Jcard Field
Contains jCard data, representing contact information in a JSON format.
public const string Jcard = "jcard";
Field Value
Remarks
This claim is used to convey contact information in a structured format that mirrors the vCard specification, facilitating interoperable exchange of personal or organizational contact details.
IanaClaimTypes.Jti Field
Provides a unique identifier for the JWT.
public const string Jti = "jti";
Field Value
Remarks
Defined in RFC 7519, Section 4.1.7. The "jti" (JWT ID) claim is a case-sensitive string. Use this claim to prevent the JWT from being replayed.
IanaClaimTypes.Locale Field
Represents the user's locale.
public const string Locale = "locale";
Field Value
Remarks
Used in OpenID Connect. This claim specifies the user's preferred language and optionally, region. Typically represented as a language tag, e.g., en-US or fr-CA.
IanaClaimTypes.MayAct Field
Indicates the parties that the token bearer is authorized to act on behalf of.
public const string MayAct = "may_act";
Field Value
Remarks
This claim is used in scenarios where a token bearer is permitted to act on behalf of other parties, enabling delegation of rights and facilitating advanced authorization scenarios.
IanaClaimTypes.MiddleName Field
Represents the middle name(s) of the user.
public const string MiddleName = "middle_name";
Field Value
Remarks
Used in OpenID Connect. This claim is intended for the user's middle name(s), which might not be present for all users.
IanaClaimTypes.Mky Field
Represents a media key fingerprint.
public const string Mky = "mky";
Field Value
Remarks
Used in secure communication protocols to provide a fingerprint of the cryptographic key used for encrypting media, enhancing the security of media exchanges by facilitating key verification.
IanaClaimTypes.Name Field
Represents the full name of the user.
public const string Name = "name";
Field Value
Remarks
Used in OpenID Connect for representing the user's full name in a single string. It might include the first, middle, last, and other names.
IanaClaimTypes.Nbf Field
Defines a time before which the JWT MUST NOT be accepted for processing.
public const string Nbf = "nbf";
Field Value
Remarks
Defined in RFC 7519, Section 4.1.5. The "nbf" (Not Before) claim is a NumericDate value. This claim helps in ensuring that a JWT is not accepted before a certain time.
IanaClaimTypes.Nickname Field
Represents the casual name of the user.
public const string Nickname = "nickname";
Field Value
Remarks
Used in OpenID Connect. This claim is for the user's casual or informal name that might differ from their legal name.
IanaClaimTypes.Nonce Field
A string value used to associate a client session with an ID Token.
public const string Nonce = "nonce";
Field Value
Remarks
Used in OpenID Connect to mitigate replay attacks by binding a session to a token.
IanaClaimTypes.Opt Field
Contains the original PASSporT in full form, often used in call diversion scenarios.
public const string Opt = "opt";
Field Value
Remarks
This claim is utilized in telecommunications to verify the authenticity of redirected calls by providing a cryptographic assertion of the call's origin, enhancing trust and security in voice communications.
IanaClaimTypes.Orig Field
Represents the originating identity in telecommunication protocols.
public const string Orig = "orig";
Field Value
Remarks
It's used to convey the identity of the originator in communication protocols, aiding in the identification and verification of the call origin for security and billing purposes.
IanaClaimTypes.Origid Field
Represents the originating identifier in the SHAKEN framework.
public const string Origid = "origid";
Field Value
Remarks
Used to uniquely identify the originator of a call within the SHAKEN framework, facilitating traceability and verification of the call's origin, and enhancing trust in telecommunication ecosystems.
IanaClaimTypes.PhoneNumber Field
Represents the user's phone number.
public const string PhoneNumber = "phone_number";
Field Value
Remarks
Used in OpenID Connect. This claim provides the user's preferred phone number. The format of the number can vary and it's not guaranteed to be in a standard format.
IanaClaimTypes.PhoneNumberVerified Field
Indicates whether the user's phone number has been verified.
public const string PhoneNumberVerified = "phone_number_verified";
Field Value
Remarks
Used in OpenID Connect as a boolean. True if the user's phone number has been verified; otherwise false.
IanaClaimTypes.Picture Field
Represents the URL of the user's profile picture.
public const string Picture = "picture";
Field Value
Remarks
Used in OpenID Connect. This claim provides a URL pointing to a profile picture or avatar of the user.
IanaClaimTypes.PreferredUsername Field
The username preferred by the user, which may be different from their actual or legal name.
public const string PreferredUsername = "preferred_username";
Field Value
Remarks
This claim is used to convey the user's preferred username within the system. It allows the user to specify a nickname or alias that is used within the application for display purposes, providing a more personalized user experience.
IanaClaimTypes.Profile Field
Represents the URL of the user's profile page.
public const string Profile = "profile";
Field Value
Remarks
Used in OpenID Connect. It is the URL of a web page containing information about the user or a social profile page.
IanaClaimTypes.Public Field
A set of public claims that can be defined by applications as needed. To ensure global uniqueness and avoid collisions, these claims should either be registered with the IANA JSON Web Token Registry or be defined within a namespace that is resistant to collisions, such as a URI.
public static readonly IReadOnlyCollection<string> Public;
Field Value
System.Collections.Generic.IReadOnlyCollection<System.String>
IanaClaimTypes.Registered Field
A set of predefined claims recommended for ensuring interoperability among different systems. These claims are widely recognized and provide basic information necessary for many authentication and authorization processes.
public static readonly IReadOnlyCollection<string> Registered;
Field Value
System.Collections.Generic.IReadOnlyCollection<System.String>
IanaClaimTypes.Roles Field
Represents the roles associated with the subject, often used in System for Cross-domain Identity Management (SCIM).
public const string Roles = "roles";
Field Value
Remarks
This claim is used to convey the roles attributed to a subject, facilitating role-based access control (RBAC) and other authorization decisions in systems implementing SCIM or similar identity management protocols.
IanaClaimTypes.Rph Field
Represents a resource priority header.
public const string Rph = "rph";
Field Value
Remarks
This claim is used to indicate the priority of a resource or process in network communications, ensuring that critical resources receive appropriate handling and prioritization in congested or limited-capacity environments.
IanaClaimTypes.Scope Field
Represents the scope associated with an access token.
public const string Scope = "scope";
Field Value
Remarks
Specifies the permissions or access rights granted to an access token, defining what actions the token bearer is authorized to perform. This claim is fundamental in controlling access to resources.
IanaClaimTypes.Sid Field
Represents the session ID for front-channel logout in OpenID Connect sessions.
public const string Sid = "sid";
Field Value
Remarks
This claim is critical for implementing front-channel logout mechanisms, allowing clients and servers to coordinate user sessions and logout processes across multiple applications and services.
IanaClaimTypes.SigValClaims Field
Contains claims used for validating signatures, often in security contexts.
public const string SigValClaims = "sig_val_claims";
Field Value
Remarks
This claim set is essential for scenarios where signature validation is critical, providing necessary information to verify the authenticity and integrity of signed data or tokens in secure communications and transactions.
IanaClaimTypes.SipCallid Field
"sip_callid" - Value from the SIP 'Call-Id' header field, uniquely identifying the SIP call.
public const string SipCallid = "sip_callid";
Field Value
IanaClaimTypes.SipCseqNum Field
"sip_cseq_num" - Numeric value from the SIP 'CSeq' header field, indicating the command sequence number in SIP protocol.
public const string SipCseqNum = "sip_cseq_num";
Field Value
IanaClaimTypes.SipDate Field
"sip_date" - Value from the SIP 'Date' header field, indicating the time of the SIP message.
public const string SipDate = "sip_date";
Field Value
IanaClaimTypes.SipFromTag Field
"sip_from_tag" - Value from the SIP 'From' tag header field, used in SIP-based communications.
public const string SipFromTag = "sip_from_tag";
Field Value
IanaClaimTypes.SipViaBranch Field
"sip_via_branch" - Value from the SIP 'Via' branch parameter, used in routing SIP messages.
public const string SipViaBranch = "sip_via_branch";
Field Value
IanaClaimTypes.Sph Field
Used to indicate the priority of a SIP message.
public const string Sph = "sph";
Field Value
Remarks
This claim is relevant in Session Initiation Protocol (SIP)-based communications, where it may influence routing, handling, and processing priorities of SIP messages, ensuring that critical communications are appropriately prioritized.
IanaClaimTypes.Sub Field
Represents the principal that is the subject of the JWT.
public const string Sub = "sub";
Field Value
Remarks
Defined in RFC 7519, Section 4.1.2. The "sub" value is a case-sensitive string containing a StringOrURI value. This claim is used to identify the subject of the JWT, which could be an end user or a device.
IanaClaimTypes.SubJwk Field
Represents the subject's public key as a JSON Web Key (JWK).
public const string SubJwk = "sub_jwk";
Field Value
Remarks
Used in scenarios where public keys are associated with JWT subjects. This claim allows embedding a public key directly within a JWT, facilitating key discovery and distribution.
IanaClaimTypes.Toe Field
Represents the time of the security event.
public const string Toe = "toe";
Field Value
Remarks
This claim is used in Security Event Tokens (SETs) to indicate the precise time at which the described security event occurred, facilitating accurate incident tracking and response.
IanaClaimTypes.TokenIntrospection Field
Contains the response from an OAuth 2.0 token introspection request.
public const string TokenIntrospection = "token_introspection";
Field Value
Remarks
This claim is typically used in scenarios where detailed token information is necessary for validating token status, scopes, and other attributes as part of OAuth 2.0 introspection processes.
IanaClaimTypes.Txn Field
Represents a transaction identifier.
public const string Txn = "txn";
Field Value
Remarks
Often utilized in financial transactions and other scenarios where tracking the identity and state of individual transactions is critical for security, auditing, and reconciliation processes.
IanaClaimTypes.UpdatedAt Field
Indicates when the user's information was last updated.
public const string UpdatedAt = "updated_at";
Field Value
Remarks
Used in OpenID Connect. This claim provides a Unix time stamp indicating when the user's information was last updated.
IanaClaimTypes.Vc Field
Represents a verifiable credential as specified in the W3C Recommendation.
public const string Vc = "vc";
Field Value
Remarks
This claim is used to convey credentials that can be cryptographically verified, supporting a wide range of applications from identity verification to qualification attestation in a secure and interoperable manner.
IanaClaimTypes.Vot Field
Represents the vector of trust for authentication processes.
public const string Vot = "vot";
Field Value
Remarks
Used to convey the level of confidence in the authentication process, detailing the methods used and their security properties. This claim is particularly useful in contexts requiring a nuanced understanding of authentication assurance.
IanaClaimTypes.Vp Field
Represents a verifiable presentation as specified in the W3C Recommendation.
public const string Vp = "vp";
Field Value
Remarks
This claim is used when a subject presents one or more verifiable credentials, allowing the verifier to check the authenticity and integrity of the credentials presented, facilitating trusted digital interactions.
IanaClaimTypes.Vtm Field
Represents the vector of trust trustmark.
public const string Vtm = "vtm";
Field Value
Remarks
Provides a URL to a trustmark that further describes the trust vector associated with the authentication process, offering a means to verify the authentication methods and their adherence to certain standards or practices.
IanaClaimTypes.Website Field
Represents the URL of the user's web page or blog.
public const string Website = "website";
Field Value
Remarks
Used in OpenID Connect. This claim indicates the URL of the user's personal or business website.
IanaClaimTypes.Zoneinfo Field
Represents the user's time zone.
public const string Zoneinfo = "zoneinfo";
Field Value
Remarks
Used in OpenID Connect. This claim indicates the user's time zone, facilitating localization and personalization.