Skip to content

SsfScopes Class

The OAuth scopes governing the Stream Management API.

C#
public static class SsfScopes

Inheritance System.Object → SsfScopes

Remarks

The CAEP Interoperability Profile 1.0 draft 01 Section 2.7.3 defines both and reserves the prefix: "Scopes values beginning with 'ssf.' are reserved and MUST only be defined by the SSF specifications." So this file is a transcription, not a design - a deployment inventing a third ssf. scope is outside the profile whatever it does with it.

An authorization server issuing tokens to receivers has to be able to grant these two. This library's own authorization server refuses a scope nobody registered, so a deployment running both declares them alongside its other scopes; nothing here reaches into that side, and nothing there needs to know about Shared Signals.

Fields

SsfScopes.Manage Field

Reading plus changing: "The ssf.manage scope includes all ssf.read permissions and additionally allows Create Stream, Delete Stream, and Stream Verification operations."

C#
public const string Manage = "ssf.manage";

Field Value

System.String

Remarks

A caller holding this holds Read as well, by that sentence, so a check for read access is satisfied by either.

SsfScopes.Read Field

Reading, and nothing else: "The ssf.read scope allows Read Stream Configuration and Get Stream Status operations."

C#
public const string Read = "ssf.read";

Field Value

System.String

Methods

SsfScopes.Satisfies(IEnumerable<string>, string) Method

Whether granted satisfies required, with the inclusion the profile states: Manage covers Read, and not the other way round.

C#
public static bool Satisfies(System.Collections.Generic.IEnumerable<string> granted, string required);

Parameters

granted System.Collections.Generic.IEnumerable<System.String>
required System.String

Returns

System.Boolean