Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Federationskontext BAS: OAuth 2.0 Metadata Requirements 1.0, draft 01



PublishedSeptember 2026
WorkgroupSamordnad identitet och behörighet
OrganizationThe Swedish Agency for Digital Government (Digg)

Abstract

This specification defines the metadata requirements for OAuth 2.0 Clients, Authorization Servers and Protected Resources participating in Federationskontext BAS, a federation context for machine-to-machine access within the Swedish public sector. The metadata is published in Entity Configurations according to OpenID Federation 1.01. The requirements apply to the resolved metadata, meaning the metadata that results once the Trust Chain of an Entity has been applied to the declarations the Entity makes about itself. The requirements are limited to what a party needs in order to primary purpose of the requirements is that a party can verify the system identity of an Entity and the organization it is registered for. The requirements also support interoperability according to the Ena OAuth 2.0 Interoperability Profile, and the registration of Clients at Authorization Servers, in that identifiers, keys, authentication methods, endpoints and algorithms are obtained from resolved metadata. They do not regulate the information exchange that follows, including which scopes are defined or requested and what access a Client is granted.

Table of Contents

  1. Introduction 1.1. Requirements Notation and Conventions 1.2. Terminology 1.3. Scope of the Requirements
  2. General Requirements
  3. Common Requirements 3.1. The organization_identifier Format 3.2. Protocol Keys
  4. OAuth Client Requirements 4.1. Client Identifier 4.2. Client Authentication
  5. Authorization Server Requirements
  6. Protected Resource Requirements 6.1. Resource Identifier
  7. BAS Metadata Policies 7.1. Trust Anchor Metadata Policy 7.2. Registration Intermediate Metadata Assignment
  8. Normative References
  9. Informative References

Appendix A. Notices Appendix B. Document History

...

1. Introduction

This document specifies the metadata that an OAuth 2.0 Client, Authorization Server or Protected Resource publishes when it joins Federationskontext BAS, hereafter BAS. It is written for the organizations that operate such Entities, and for the developers and operators who implement them. How BAS is structured, and how an Entity is registered in it, is described in [BAS.Rules].

BAS is a federation context for machine-to-machine access within, and towards, the Swedish public sector. It exists so that a party can verify the system identity of another party's Entity, and which organization that Entity is registered for, before any information is exchanged. This is the primary purpose of the requirements in this document. The same metadata also serves two further purposes. It supports interoperability according to the Ena OAuth 2.0 Interoperability Profile [Ena.OAuth2], in that the endpoints, keys, algorithms and authentication methods that parties need in order to interact are published in Resolved Metadata rather than agreed bilaterally. It also supports Client Registration, in that the Client's identifier, keys and authentication method can be taken from its Resolved Metadata. Meeting the requirements does not by itself ensure that two Entities can interoperate, nor does it result in Client Registration at every Authorization Server in BAS. [Ena.OAuth2] leaves some choices to the individual Entity, such as whether mutual TLS is supported for client authentication, and the scopes, resources and access that an exchange depends on are agreed between the parties. Whether an Authorization Server accepts a Client, and what access it grants, remains the Authorization Server's decision. Every requirement in this document is derived from that purposethese purposes, and the document places no requirements beyond itthem. Section 1.3 states where the boundary lies.

Verifying an Entity's identity and organizational connection involves two kinds of rules. What the organizational connection means, how a Federation Registration Intermediate Operator establishes it, and how a presentation name is checked, is stated in Requirements and Guidance for Verification of Organisational Affiliation Affiliation (Swedish: Tillämpningskrav och vägledning för verifiering av organisationskoppling) and Requirements and Requirements and Guidance for Verification of Display Name Name (Swedish: Tillämpningskrav och vägledning för verifiering av visningsnamn).  This This document states how the outcome of those checks is expressed in metadata, so that a peer can read it. The documents are meant to be read together. A metadata value assigned under this specification carries exactly the meaning given to it by the corresponding tillämpningskravrequirement, and no other.

The protocol requirements build on [Ena.OAuth2], which is the OAuth 2.0 profile that BAS applies. Entities in BAS adhere to that profile, and this . This document restates its metadata requirements at the levels it gives, adding and adds the constraints that follow from operating in a federation, where a Client joins the federation rather than registering separately with each Authorization Server it uses. Where the profile leaves a parameter optional but the purposes above require it to be present, this document raises the requirement level. This is the current scope rather than a permanent limitation. BAS may later admit other Entity Types, and Entities adhering to other profiles, and the requirements in this document would then not apply to them unaltered.

The requirements build on a number of further specifications. [OpenID.Federation] defines how metadata is published and resolved, and . [OIDC.Sweden.Federation] profiles OpenID Federation for use in Swedish federations, a profile that BAS follows, and requires that an Authorization Server accepts and incorporates the metadata of a Client registered in the federation. [RFC7591], [RFC8414] and [RFC9728] define the metadata parameters for the three Entity Types. [OIDC.Sweden.OrgId] defines the parameter that identifies the organization behind an Entity.

The requirement chapters state what has to appear in the resolved metadata Resolved Metadata of an Entity. Common Requirements covers the parameters that all three Entity Types share and that express identity and organizational connection. These requirements do not depend on the choices made for BAS, and are specified so that they can be applied unaltered in other federation contexts. The chapters on Clients, Authorization Servers and Protected Resources contain the requirements that are specific to BAS, including those that support interoperability and Client Registration. BAS Metadata Policies shows how the requirements are enforced, through the metadata policy that the BAS Trust Anchor applies to every Entity, and through the per-Entity values that a Federation Registration Intermediate Entity sets when an Entity joins the federation. Within BAS these two roles are held by different organizations, the Federation Operator and a Federation Registration Operator, and the document states for every assigned or constrained value which of them controls it.

1.1. Requirements Notation and Conventions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

1.2. Terminology

This specification uses the terms "Entity", "Entity Configuration", "Entity Identifier", "Entity Type Identifier", "Intermediate Entity", "Leaf Entity", "Subordinate Statement", "Trust Anchor", "Trust Chain" and "Resolved Metadata" as defined in [OpenID.Federation], and the terms "Federation Protocol Entity" and "Federation Registration Entity" as defined in [OIDC.Sweden.Federation]. It uses the terms "Client", "Authorization Server" and "Protected Resource" as defined in [Ena.OAuth2]. Within BAS, the Federation Registration Entity is the connection service (Swedish: anslutningstjänst) that a Federation Registration Operator provides.

This specification also defines the following terms:

Client Registration : The incorporation of a Client into the service configuration of an Authorization Server, based on the Client's Resolved Metadata. Client Registration is distinct from the registration of an Entity in BAS, which a Federation Registration Entity performs by issuing a Subordinate Statement for the Entity.

Federation Member (Swedish: Federationsmedlem) : An organization that has entered into an agreement on connection as a federation member, and on whose behalf Entities are registered in BAS.

Federation Operator (Swedish: Federationsoperatör) : The organization that operates the BAS Trust Anchor. For BAS, this is the Swedish Agency for Digital Government (Digg).

Federation Registration Operator (Swedish: Anslutningsoperatör) : An organization that connects Federation Members to BAS and registers their Entities.

1.3. Scope of the Requirements

The requirements in this document serve one function: that a party can verify who it is about to exchange information with. To that end, this document regulates

...