Class ApiScope

Namespace

Duende.IdentityServer.Models

Assembly

Duende.IdentityServer.Storage.dll

Models access to an API scope

public class ApiScope : Resource

Inheritance

object

Resource

ApiScope

Inherited Members

Resource.Enabled

Resource.Name

Resource.DisplayName

Resource.Description

Resource.ShowInDiscoveryDocument

Resource.UserClaims

Resource.Properties

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ApiScope()

Initializes a new instance of the ApiScope class.

public ApiScope()

ApiScope(string)

Initializes a new instance of the ApiScope class.

public ApiScope(string name)

Parameters

name string

The name.

ApiScope(string, IEnumerable<string>)

Initializes a new instance of the ApiScope class.

public ApiScope(string name, IEnumerable<string> userClaims)

Parameters

name string

The name.

userClaims IEnumerable<string>

List of associated user claims that should be included when this resource is requested.

ApiScope(string, string)

Initializes a new instance of the ApiScope class.

public ApiScope(string name, string displayName)

Parameters

name string

The name.

displayName string

The display name.

ApiScope(string, string, IEnumerable<string>?)

Initializes a new instance of the ApiScope class.

public ApiScope(string name, string displayName, IEnumerable<string>? userClaims)

Parameters

name string

The name.

displayName string

The display name.

userClaims IEnumerable<string>

List of associated user claims that should be included when this resource is requested.

Exceptions

ArgumentNullException

name

Properties

Emphasize

Specifies whether the consent screen will emphasize this scope. Use this setting for sensitive or important scopes. Defaults to false.

public bool Emphasize { get; set; }

Property Value

bool

Required

Specifies whether the user can de-select the scope on the consent screen. Defaults to false.

public bool Required { get; set; }

Property Value

bool