hash
stringlengths
32
32
doc_id
stringlengths
7
13
section
stringlengths
3
121
content
stringlengths
0
2.2M
baa46c383033a4406946797fe47211ae
103 357
7.4.2.4 Wakeup PDU
Each Wakeup PDU contains 2 wakeup messages. Each wakeup message is 18 bits long which is evaluated and filled at physical layer, according to what is going to be transmitted on the data channel so that relevant EP stay up and anticipate, whereas others go to sleep and save power. Each wakeup message contains 14 bits Co...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.5 Multicast L1 SDU and PDU
Multicast L1 SDU can have two different lengths (51 bits and 139 bits). The Multicast Short L1 pre-coding block is identical to the Multicast Short L1 SDU and therefore is 51 bits. The Multicast Long L1 pre-coding block is described in Table 7-10. ETSI ETSI TS 103 357 V1.1.1 (2018-06) 93 Table 7-10: Multicast Long L1 p...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.6 Control L1 SDU and PDU
baa46c383033a4406946797fe47211ae
103 357
7.4.2.6.1 Overview
The Control L1 SDU is always 135 bits long with the format shown in Table 7-11. Table 7-11: Control L1 SDU Field Length (bits) Notes SSID 10 Short System ID. Direction 1 0 = towards Service Centre. 1 = away from Service Centre. L2 BSID 13 If Direction = 1: L2 BSID identifies the BS sending towards destination EP, or id...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.6.2 A-interface Downlink and A"-interface
On A-interface DL and A"-interface the pre-coding block is shown in Table 7-12. ETSI ETSI TS 103 357 V1.1.1 (2018-06) 94 Table 7-12: Downlink/A" Control L1 pre-coding block Field Length (bits) Notes Reserved 1 Reserved field (set to 0) Content 135 Control L1 SDU In this case Control L1 PDU is 168 bits if normal coding ...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.6.3 A-interface Uplink
In UL there is only one physical channel (UDPCH) to carry both control and connection data, the corresponding PDU is called Data L1 PDU. For normal coding strength see Table 7-13. Table 7-13: Uplink Data L1 pre-coding block - normal strength coding Field Length (bits) Notes Content Type 1 = 0 for Control Content 135 Co...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.7 Connection L1 SDU and PDU
baa46c383033a4406946797fe47211ae
103 357
7.4.2.7.1 Connection L1 SDU
Connection L1 SDU is 131 bits long as described in Table 7-16. ETSI ETSI TS 103 357 V1.1.1 (2018-06) 95 Table 7-16: Connection L1 SDU Field Length (bits) Notes ConID 14 Connection ID BlkNum 5 PDU block number allocated by layer 3 Content 112 payload (14 bytes)
baa46c383033a4406946797fe47211ae
103 357
7.4.2.7.2 A-interface Downlink and A"-interface
PHY extracts Connection ID (14 bits) from the Connection L1 SDU and puts it in Wakeup PDU as explained in clause 7.4.2.4. The Connection L1 pre-coding block is shown in Table 7-17. Table 7-17: A-interface Downlink/A" Connection L1 pre-coding block Field Length (bits) Notes Reserved 7 Reserved field (set to 0) Content 1...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.7.3 A-interface Uplink
In this case, the pre-coding block contains Connection L1 SDU (including its ConID field) plus 5 bits header added by PHY, so the pre-coding block is 136 bits: Table 7-18: Uplink Data L1 pre-coding block - normal strength coding Field Length (bits) Notes Content Type 1 =1 for Connection (i.e. data) XC BSGP 4 BSGP used ...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.8 Acknowledge L1 SDU
baa46c383033a4406946797fe47211ae
103 357
7.4.2.8.1 Ack Message Format
Acknowledge L1 SDU comprises a number of Ack messages declaring Connection PDUs that are successfully received on the opposite (Up/Down)link, plus some L1-specific control parameters. ETSI ETSI TS 103 357 V1.1.1 (2018-06) 96 The format of an Ack message is described in Table 7-19. Table 7-19: Ack Message Format Field L...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.8.2 Acknowledge on A"-interface and A-interface DL
For downlink, A" downlink and A" uplink, Acknowledge L1 SDU can have two different lengths, see Table 7-21 and Table 7-22. PHY adds some L1 control fields and creates long Ack L1 pre-coding block (143 bits) or short Ack L1 pre-coding block (51 bits), which are then coded using the WAC or AC codeword respectively. The r...
baa46c383033a4406946797fe47211ae
103 357
7.4.2.8.3 Acknowledge on A-interface UL
For A-interface uplink, Acknowledge L1 SDU is always 21 bits long. PHY creates Uplink Ack L1 pre-coding block which is 31 bits long as Table 7-25. ETSI ETSI TS 103 357 V1.1.1 (2018-06) 98 Table 7-25: Uplink Ack L1 pre-coding block Field Length (bits) Notes Reserved 1 Reserved field (set to (0)) AC BSGP 4 BSGP used for ...
baa46c383033a4406946797fe47211ae
103 357
7.4.3 PHY Functions
baa46c383033a4406946797fe47211ae
103 357
7.4.3.1 Channel Processing
Figure 7-11 illustrates the channel processing applied in the physical layer for the A-interface Downlink transmission. L2 PDUs are passed to the PHY through logical channels (which is then called L1 SDU). L1 SDUs are passed as described in clause 7.4.2 as pre-coding blocks to PHY channel coding function which performs...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.2 Channel Coding
All data transmitted by either Base Station or End-point shall be encoded using shortened BCH cyclic codes as described in Table 7-26, Table 7-27 and Table 7-28. ETSI ETSI TS 103 357 V1.1.1 (2018-06) 101 Table 7-26: Downlink Codewords Code Type Base Code Shortened Form Properties DL BCH Codewords n k n' k' rate t (used...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3 Data-Burst Building
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3.1 Introduction
In the DD-UNB system, a data-burst typically occupies multiple timeslots. Data-bursts of different types are used for A- interface (Downlink, Uplink and Uplink Ack) and A"-interface (Downlink and Uplink). The transmission of data-bursts is generally determined by application requirements and those of other protocol lay...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3.2 A-interface DL
Each A-interface DL data-burst shall comprise, in the order shown, a concatenation of: • A Sync PDU (a Sync header of 80 bits followed by 112 bits SC codeword and then a guard period) which fits exactly into one timeslot (0,4 second). • A single BC which carries the details of the sequence of codewords that follows it....
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3.3 A-interface UL Data
Each A-interface UL Data data-burst shall comprise a Sync header of 16 bits (see Table 7-4) followed by a CC/XC codeword (176 bits) or a double SCC/XCC codeword (352 bits), occupying 8 or 16 timeslots. A resulting 16-slot data- burst shall be divided into a first and second sequential (but not necessarily contiguous) 8...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3.4 A-interface UL Ack
Each A-interface Uplink Ack data-burst shall comprise a Sync header of 16 bits (see Table 7-4) followed by a single AC codeword (80 bits), occupying 4 timeslots. Zero or more UL Ack data-bursts may be transmitted by an EP/RP in each UL subframe, see Figure 7-12, subject to frame and subframe format constraints. Timing ...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3.5 A"-interface DL
Each A"-interface DL data-burst shall comprise, in the order shown, a concatenation of: • A Sync PDU (a Sync header of 80 bits followed by 112 bits SC codeword and then a guard period) which fits exactly into one timeslot (0,4 second). • A single BC which carries the details of the sequence of codewords that follows it...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3.6 A"-interface UL Data data-burst
Each A"-interface UL data-burst shall comprise, in the order shown, a concatenation of: • A Sync PDU (a Sync header of 80 bits followed by 112 bits DC codeword and then a guard period) which fits exactly into one timeslot (0,4 second). ETSI ETSI TS 103 357 V1.1.1 (2018-06) 103 • Zero or more CC/SCC codewords. • Zero or...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3.7 A"-interface UL Ack data-burst
A"-interface Uplink Ack data-burst shall always start with a specific Sync header of 16 bits (as in Table 7-4). The remainder of the data-burst consists of a single AC codeword (80 bits). A RP shall transmit no more than one such data-burst in each A"-interface UL subframe, subject to frame and subframe format constrai...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.3.8 Bit order
Each pre-coding block shall be packed with the last entry in its pre-coding block table in the least significant location of the PDU (without changing bit order) and then each preceding entry shall be added in more significant locations (in the same bit order). The packed and coded PDU is transmitted least significant ...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.4 Power Control
Power control is used in A-interface Uplink transmission by EP. Provision is made in PHY to control transmit power level using "Too Loud" flag. When the received RSSI at the BS is higher than an implementation-dependent defined threshold, BS may indicate "Too Loud" (see Table 7-23) in which case the EP shall reduce its...
baa46c383033a4406946797fe47211ae
103 357
7.4.3.5 High Interference Mode
As described in this specification, strong and weak coding is available for a range of PDUs. The choice of coding scheme shall be made by the related entity and shall be signalled as described (e.g. Table 7-9). Choice of algorithm by which to determine whether to use High Interference Mode is implementation dependent, ...
baa46c383033a4406946797fe47211ae
103 357
7.4.4 PHY Procedures
baa46c383033a4406946797fe47211ae
103 357
7.4.4.1 Synchronization and Frequency Scanning
Layer 1 supports frequency scanning and synchronization processes to detect available BS and RP. This process is implementation-dependent.
baa46c383033a4406946797fe47211ae
103 357
7.4.4.2 Base Selection
The process by which an EP selects a BS / RP with which to attempt connection is implementation-dependent.
baa46c383033a4406946797fe47211ae
103 357
7.4.4.3 Transmit Duty-Cycle Control
DD-UNB implementations are typically subject to regulatory limits on transmitter duty cycle. It is an implementation issue to ensure such limits are not exceeded.
baa46c383033a4406946797fe47211ae
103 357
7.4.4.4 A-interface Downlink Transmission Control - Frame Structure
Before the start of each frame, BS shall determine the frame format to use for that frame as described in clause 7.4.1.1. This process is implementation-dependent. Transmission of DL data-bursts shall commence in the first timeslot allocated to the related subframe, see Table 7-1.
baa46c383033a4406946797fe47211ae
103 357
7.4.4.5 A"-interface Downlink Transmission Control - Subframe Structure
Before the start of each A"-interface subframe, RP shall determine the format to use for that subframe as described in clause 7.4.1.1. This process is implementation-dependent.
baa46c383033a4406946797fe47211ae
103 357
7.4.4.6 Uplink Transmission Control
BS transmissions are the reference for both the time and the frequency of EP and RP transmissions. No allowance for propagation delays is required in the timing of uplink transmissions.
baa46c383033a4406946797fe47211ae
103 357
7.4.4.7 PHY Measurements
PHY measurements are implementation-dependent and may include: • the average power (RSSI) of the Sync Word in a data-burst; • the number of corrected bits in each received codeword; or other measurements. Such measurements may be used to support "too loud" indication (clause 7.4.3.4).
baa46c383033a4406946797fe47211ae
103 357
7.4.4.8 Noise Measurement
Some A-interface frame formats allocate "noise measurement" timeslots during which no system elements transmit. These may be used to measure noise and/or interference levels; such measurements, and the use of the results, are implementation-dependent. ETSI ETSI TS 103 357 V1.1.1 (2018-06) 105
baa46c383033a4406946797fe47211ae
103 357
7.4.4.9 Base-System Group (BSGP)
To enable the BS to distinguish reception of a local EP's (intended) transmissions from distant EP's (unintended) transmissions (in the case that block numbers coincide), "Uplink Connection Base-System Group" (XC BSGP) is included in each Data L1 PDU on the A-interface UL, see Table 7-18. XC BSGP (see Table 7-18) has t...
baa46c383033a4406946797fe47211ae
103 357
7.5 Radio characteristics
baa46c383033a4406946797fe47211ae
103 357
7.5.1 Frequency Structure - Radio Mode 0
Clause 7.5.1 and any subclauses describe DD-UNB operation in Radio Mode 0; other modes are for further study. Table 7-29: Radio Mode definition Radio Mode Downlink / A" Uplink Bit-rate (bps) Symbol-rate (Hz) Deviation Δf (Hz) Bit-rate (bps) Symbol-rate (Hz) Deviation Δf (Hz) 0 500 500 ±250 62,5 62,5 ±250 Other Reserved...
baa46c383033a4406946797fe47211ae
103 357
7.5.2 Modulation - Radio Mode 0
baa46c383033a4406946797fe47211ae
103 357
7.5.2.1 General
Clause 7.5.2 and subclauses describe DD-UNB operation in Radio Mode 0; other modes are for further study and may, for example, include the generation of more than one modulated carrier within the identified channel on one or more interfaces or alternative modulation schemes. The DD-UNB modulation uses Binary Frequency ...
baa46c383033a4406946797fe47211ae
103 357
7.5.2.2 A-interface DL and A"-interface (UL and DL) modulation
Within the selected 25 kHz channel a number of nominal carrier frequencies spaced at 500 Hz intervals are identified (as FDM_fc(n)) as depicted in Figure 7-17. For Radio Mode 0 A-interface DL a modulated carrier is generated at FDM_fc(10) or FDM_fc(40); the choice between these values of FDM_fc is made in network plann...
baa46c383033a4406946797fe47211ae
103 357
7.5.2.3 A-interface UL modulation
Uplink modulation is implemented based on a combination of BFSK and Random Frequency Selection (RFS). In Radio Mode 0 the UL operating channel width is 15 kHz. Each EP/RP shall perform RFS independently for each data-burst (except as described in clause 7.4.3.3.3 for strongly-coded PDUs where each pair of data-bursts s...
baa46c383033a4406946797fe47211ae
103 357
7.5.3 Radio-Burst Power Ramping
A guard period of 16 ms is provided for power-ramping and optional frequency hopping between radio-bursts; when transmitting, transmit power shall be reduced during the guard period in all entities (whether or not frequency-hopping). Transmit power shall rise or fall by ≥60 dB within 500 µs of the start or end (respect...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
1 Scope
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
1.1 General
The protocol described in the present document is intended for devices with limited input capabilities, such as hybrid radios, IP-connected set top boxes and Smart TVs, that can communicate with web services over HTTPS. The protocol specifies two APIs: • the API between a client device and an authorization provider by ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
2 References
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. Referenced documents which a...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. NOTE While any hyperlinks in...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
3 Definitions and abbreviations
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
3.1 Definitions
For the purposes of the present document, the following terms and definitions apply: access token: bearer token used by a client as authority to access a service provider authenticated association: association in which the client identity is associated with a user identity authorization: granting of permission based on...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
3.2 Abbreviations
For the purposes of the present document, the following abbreviations apply: API Application Programming Interface CPA Cross Platform Authentication NOTE The subject of the present document. HTTP Hypertext Transfer Protocol HTTPS HTTP Secure OAuth Open Authorization URI Uniform Resource Identifier ETSI ETSI TS 103 407 ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
4 Protocol overview
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
4.1 Introduction
The present document defines the protocol between a client device and an authorization provider by which a client device acquires an authorization token it may use to access protected resources and by which the service provider can identify the client device and any associated user account. Cross Platform Association (...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
4.2 Modes of association
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
4.2.1 Overview
CPA defines two modes of association: authenticated association ('user mode') which links a device to a user account, and unauthenticated association ('client mode'), which provides a client identity to a device without linking it to a user account. In both cases, the client is issued a persistent client ID so that it ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
4.2.2 Authenticated association ('user mode')
If the authorization provider offers user mode, then the client ID may be linked with a user account so that requests from the device can be linked to that user. This linking of device and user is called 'authenticated association', or user mode (see clause 7.3). Once an authenticated association has been set up, a ser...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
4.2.3 Unauthenticated association ('client mode')
The present document also defines a way to create an unauthenticated association between a device and an authorization provider, known as client mode (see clause 7.4), and a means of migrating from this unauthenticated association to an authenticated association. The purpose of unauthenticated association is to support...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
5 Core concepts
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
5.1 Bearer token
The CPA device flow is built around the concept of a bearer token, possession of which grants access to protected services IETF RFC 6750 [i.2]. ETSI ETSI TS 103 407 V1.1.1 (2016-04) 11 The core function of the CPA protocol is to securely get this bearer token onto the device. A token is a unique string that is intended...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
5.2 Domain
Tokens are valid only within the scope of the hostname of the service provider for which they are granted. This is to prevent service providers enabling the issuing of tokens for domains for which they are not responsible. Tokens are valid for all service provider endpoints in that domain. For example, a token granted ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
6 Roles
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
6.1 Client
The client represents the user of a service on a device. When a client registers with an authorization provider, it is given a unique client_id and a client_secret. The client_id is known to the client, the service provider and the authorization provider. This client identity is shared between all service providers tha...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
6.2 Service provider
The service provider provides one or more web services under the same domain. Each bearer token is valid only for the service provider domain for which it was issued. The exact details of how a service provider indicates to a client which authorization provider to use and which protected resources are accessible with a...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
6.3 Authorization provider
An authorization provider provides client identities to one or more clients and maintains the link between the client identity and the user identity. An authorization provider may answer authorization requests for one or more service providers. Service providers may be grouped within an authorization provider to share ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7 The device flow
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.1 Protocol version
This present document describes version 1.0 of the CPA protocol. The method that service providers should use to indicate the version in use is application specific, for example, see clause A.2.
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.2 Basic principles
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.2.1 HTTPS
All communication between the client and the service provider, between the client and the authorization provider, and between the service provider and the authorization provider shall be conducted over HTTPS as specified in IETF RFC 2818 [1]. Clients shall verify the certificates used by the service provider and author...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.2.2 JSON
All requests made by the client to the authorization provider shall use JSON IETF RFC 7159 [2] in the request body to specify parameters. All responses from the authorization provider shall use JSON in the response body to return data to the client. Error responses (4xx status codes) shall contain a body of the form: {...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.2.3 Integrating applications with the CPA protocol
How the client discovers the URI of the authorization provider and how it specifies the bearer token to the service provider are application specific and so outside the scope of the present document. There are, however, some conventions that have arisen in practice which should be followed where applicable: • The servi...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.2.4 Example of authenticated association using the CPA device flow
The following is an example of authenticated association using the CPA device flow from the user's point of view: • Alice turns on her radio and it starts playing her favourite channel. An application running on the radio detects that a service is available for this channel that offers Alice the ability to bookmark the...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.3 User mode
In user mode, interactions between the client and the service provider are associated with a user account. The process by which the client obtains an access token to access protected resources at the service provider is shown in figure 1: 1) The client first requests a resource from the service provider, either without...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.4 Client mode
In client mode, interactions between the client and the service provider are not associated with a user account. The authorization provider assigns a unique identifier to the client, so the service provider can store information and personalize the interaction related to this device. The process by which the client obt...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.5 Automatic provisioning of tokens
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.5.1 Overview
Service providers may be grouped within an authorization provider to share an authorization domain. This enables the automatic provisioning of tokens for service providers within the same group once a client has been verified for one service provider within that group. Once a client has established an association in us...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.5.2 User signs in and enters a pairing code
The authorization provider may require the user to sign in and enter a pairing code before granting access to a new service provider. The process by which the client obtains an access token for this service provider is shown in figure 3. The process in this case is similar to that described in clause 7.3. 1) The client...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.5.3 User signs in and gives confirmation
The authorization provider may require the user to sign in and give confirmation, without entering a pairing code, before granting access to a new service provider. The process by which the client obtains an access token for this service provider is shown in figure 4. ETSI ETSI TS 103 407 V1.1.1 (2016-04) 18 Figure 4: ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.5.4 Token is automatically granted
The authorization provider may automatically grant an access token for the new service provider, without requiring any user action. The process by which the client obtains an access token for this service provider is shown in figure 5: 1) The client requests a protected resource from a service provider without having a...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.5.5 Refreshing an expired access token
Authorization providers MAY issue access tokens that expire after a time interval. A client that uses an expired access token to access a protected resource follows the steps shown in figure 6 to obtain a new access token: 1) The client requests a protected resource at the service provider, supplying its existing acces...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.6.1 Overview
A user can delete the association between a client and an authorization provider either from the client side or the authorization provider side. The specific methods to do so are not part of the CPA specification - there is no defined API endpoint to delete an association. What follows is a brief description of how the...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.6.2 Deleting the association on the client side
To delete the association between a client and authorization provider on the client side, the client should delete the client_id and client_secret for an authorization provider and all tokens associated with that authorization provider. Without the token, the client will be issued an authentication challenge on the nex...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
7.6.3 Deleting the association on the authorization provider side
To delete the association on the authorization provider side, the authorization provider should delete all tokens associated with the client_id, all mappings between the client_id and a user_id and the client record containing the client_id and client_secret themselves, thereby invalidating the client_id by removing it...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8. Client/Authorization Provider API
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.1 Overview
This clause defines the API offered by the authorization provider to the client. It consists of the following endpoints: • /register - Register a client • /associate - Associate a client with a user account • /token - Obtain a bearer token • verification endpoint - Authenticate the user's identity and verify the associ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.2 /register - Register a client
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.2.1 /register request
The client makes a HTTP POST request to the authorization provider's registration endpoint and shall include the following parameters in a JSON object in the request body: client_name The human-readable name of the client. software_id An identifier for the client software application. This value should not change when ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.2.2 /register response
If registration is successful, the authorization provider generates a new client identifier for the client. The authorization provider responds with HTTP status 201 and shall include the following information in a JSON object in the response body: client_id A string containing a unique identifier issued to the client d...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.3 /associate - Associate a client with a user account
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.3.1 /associate request
The client makes a HTTP POST request to the authorization provider's association endpoint and shall include the following parameters in a JSON object in the request body: client_id The identifier issued to the client when it registered with the authorization provider. See clause 8.2. client_secret The secret shared wit...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.3.2 /associate response
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.3.2.1 Pairing the client with a user account
If registration is successful, the authorization provider generates a new device code and user code for the client. The authorization provider responds with HTTP status 200 and shall include the following information in a JSON object in the response body: device_code The temporary device verification code in UUID forma...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.3.2.2 Confirmation required before granting access to a new service
If the client is already associated with a user account, and that account has been granted access to a service provider that is a member of a group of service providers at the authorization provider, then when the same client wants to obtain a token to access another service provider in the same group, the authorizatio...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.3.2.3 Access automatically granted to a new service
If the client is already associated with a user account, then in order to provide single sign-on for the user, the authorization provider may automatically grant access to the new service provider without requiring user confirmation. In this case the authorization provider responds with HTTP status 200 and shall includ...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.4 /token - Obtain a bearer token
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.4.1 /token request
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.4.1.1 Client mode
The client makes a HTTP POST request to the authorization provider's token endpoint and shall include the following parameters in a JSON object in the request body: grant_type The literal string "http://tech.ebu.ch/cpa/1.0/client_credentials". client_id The client identifier issued to the client when it registered with...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.4.1.2 User mode
The client makes a HTTP POST request to the authorization provider's token endpoint at an arbitrary but reasonable interval which shall not exceed the minimum interval specified by the authorization provider in the /associate response. The request shall include the following parameters in a JSON object in the request b...
6e06e68f245f2bf3bd0d4ca07b2a95d9
103 407
8.4.1.3 Refreshing an expired access token
To replace an expired token with a new access token, the client makes a HTTP POST request to the authorization provider's /token endpoint and shall include the following parameters in a JSON object in the request body: grant_type The literal string "http://tech.ebu.ch/cpa/1.0/client_credentials". client_id The client i...