Grant Negotiation and Authorization Protocol (GNAP)

Created
2024-03-21
Last Updated
2025-04-25
Available Formats

XML
HTML
Plain text

Registries Included Below

GNAP Grant Request Parameters

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Type Reference
access_token object [RFC9635, Section 2.1.1]
access_token array of objects [RFC9635, Section 2.1.2]
subject object [RFC9635, Section 2.2]
client object [RFC9635, Section 2.3]
client string [RFC9635, Section 2.3.1]
user object [RFC9635, Section 2.4]
user string [RFC9635, Section 2.4.1]
interact object [RFC9635, Section 2.5]
interact_ref string [RFC9635, Section 5.1]
existing_access_token string [RFC9767, Section 4]

GNAP Access Token Flags

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Allowed Use Reference
bearer Request, Response [RFC9635, Sections 2.1.1 and 3.2.1]
durable Response [RFC9635, Section 3.2.1]

GNAP Subject Information Request Fields

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Type Reference
sub_id_formats array of strings [RFC9635, Section 2.2]
assertion_formats array of strings [RFC9635, Section 2.2]
sub_ids array of objects [RFC9635, Section 2.2]

GNAP Assertion Formats

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Reference
id_token [RFC9635, Section 3.4.1]
saml2 [RFC9635, Section 3.4.1]

GNAP Client Instance Fields

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Type Reference
key object [RFC9635, Section 7.1]
key string [RFC9635, Section 7.1.1]
class_id string [RFC9635, Section 2.3]
display object [RFC9635, Section 2.3.2]

GNAP Client Instance Display Fields

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Type Reference
name string [RFC9635, Section 2.3.2]
uri string [RFC9635, Section 2.3.2]
logo_uri string [RFC9635, Section 2.3.2]

GNAP Interaction Start Modes

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Mode Type Reference
redirect string [RFC9635, Section 2.5.1.1]
app string [RFC9635, Section 2.5.1.2]
user_code string [RFC9635, Section 2.5.1.3]
user_code_uri string [RFC9635, Section 2.5.1.4]

GNAP Interaction Finish Methods

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Method Reference
redirect [RFC9635, Section 2.5.2.1]
push [RFC9635, Section 2.5.2.2]

GNAP Interaction Hints

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Reference
ui_locales [RFC9635, Section 2.5.3]

GNAP Grant Response Parameters

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Type Reference
continue object [RFC9635, Section 3.1]
access_token object [RFC9635, Section 3.2.1]
access_token array of objects [RFC9635, Section 3.2.2]
interact object [RFC9635, Section 3.3]
subject object [RFC9635, Section 3.4]
instance_id string [RFC9635, Section 3.5]
error object [RFC9635, Section 3.6]

GNAP Interaction Mode Responses

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Reference
redirect [RFC9635, Section 3.3]
app [RFC9635, Section 3.3]
user_code [RFC9635, Section 3.3]
user_code_uri [RFC9635, Section 3.3]
finish [RFC9635, Section 3.3]
expires_in [RFC9635, Section 3.3]

GNAP Subject Information Response Fields

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Type Reference
sub_ids array of objects [RFC9635, Section 3.4]
assertions array of objects [RFC9635, Section 3.4]
updated_at string [RFC9635, Section 3.4]

GNAP Error Codes

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Error Reference
invalid_request [RFC9635, Section 3.6]
invalid_client [RFC9635, Section 3.6]
invalid_interaction [RFC9635, Section 3.6]
invalid_flag [RFC9635, Section 3.6]
invalid_rotation [RFC9635, Section 3.6]
key_rotation_not_supported [RFC9635, Section 3.6]
invalid_continuation [RFC9635, Section 3.6]
user_denied [RFC9635, Section 3.6]
request_denied [RFC9635, Section 3.6]
unknown_interaction [RFC9635, Section 3.6]
unknown_user [RFC9635, Section 3.6]
too_fast [RFC9635, Section 3.6]
too_many_attempts [RFC9635, Section 3.6]

GNAP Key Proofing Methods

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Method Type Reference
httpsig string [RFC9635, Section 7.3.1]
httpsig object [RFC9635, Section 7.3.1]
mtls string [RFC9635, Section 7.3.2]
jwsd string [RFC9635, Section 7.3.3]
jws string [RFC9635, Section 7.3.4]

GNAP Key Formats

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Format Reference
jwk [RFC9635, Section 7.1]
cert [RFC9635, Section 7.1]
cert#S256 [RFC9635, Section 7.1]

GNAP Authorization Server Discovery Fields

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9635]
Available Formats

CSV
Name Type Reference
grant_request_endpoint string [RFC9635, Section 9]
interaction_start_modes_supported array of strings [RFC9635, Section 9]
interaction_finish_methods_supported array of strings [RFC9635, Section 9]
key_proofs_supported array of strings [RFC9635, Section 9]
sub_id_formats_supported array of strings [RFC9635, Section 9]
assertion_formats_supported array of strings [RFC9635, Section 9]
key_rotation_supported boolean [RFC9635, Section 9]

GNAP Token Formats

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9767]
Available Formats

CSV
Name Status Description Reference
jwt-signed Active JSON Web Token, signed with JWS [RFC7519]
jwt-encrypted Active JSON Web Token, encrypted with JWE [RFC7519]
macaroon Active Macaroon [MACAROON]
biscuit Active Biscuit [BISCUIT]
zcap Active ZCAP [ZCAPLD]

GNAP Token Introspection Request

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9767]
Available Formats

CSV
Name Type Reference
access_token string [RFC9767, Section 3.3]
proof string [RFC9767, Section 3.3]
resource_server object/string [RFC9767, Section 3.3]
access array of strings/objects [RFC9767, Section 3.3]

GNAP Token Introspection Response

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9767]
Available Formats

CSV
Name Type Reference
active boolean [RFC9767, Section 3.3]
access array of strings/objects [RFC9767, Section 3.3]
key object/string [RFC9767, Section 3.3]
flags array of strings [RFC9767, Section 3.3]
exp integer [RFC9767, Section 3.3]
iat integer [RFC9767, Section 3.3]
nbf integer [RFC9767, Section 3.3]
aud string or array of strings [RFC9767, Section 3.3]
sub string [RFC9767, Section 3.3]
iss string [RFC9767, Section 3.3]
instance_id string [RFC9767, Section 3.3]

GNAP Resource Set Registration Request Parameters

Registration Procedure(s)
Expert Review
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9767]
Available Formats

CSV
Name Type Reference
access array of strings/objects [RFC9767, Section 3.4]
resource_server object/string [RFC9767, Section 3.4]
token_formats_supported array of strings [RFC9767, Section 3.4]
token_introspection_required boolean [RFC9767, Section 3.4]

GNAP Resource Set Registration Response Parameters

Registration Procedure(s)
Expert Review
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9767]
Available Formats

CSV
Name Type Reference
resource_reference string [RFC9767, Section 3.4]
instance_id string [RFC9767, Section 3.4]
introspection_endpoint string [RFC9767, Section 3.4]

GNAP RS-Facing Discovery Document Fields

Registration Procedure(s)
Expert Review
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9767]
Available Formats

CSV
Name Type Reference
introspection_endpoint string [RFC9767, Section 3.1]
token_formats_supported array of strings [RFC9767, Section 3.1]
resource_registration_endpoint string [RFC9767, Section 3.1]
grant_request_endpoint string [RFC9767, Section 3.1]
key_proofs_supported array of strings [RFC9767, Section 3.1]

GNAP RS-Facing Error Codes

Registration Procedure(s)
Specification Required
Expert(s)
Justin Richer, Joseph Salowey, Sudesha Shetty
Reference
[RFC9767]
Available Formats

CSV
Error Reference
invalid_request [RFC9767, Section 3.5]
invalid_resource_server [RFC9767, Section 3.5]
invalid_access [RFC9767, Section 3.5]