Class ApiScope

Inheritance
System.Object
ApiScope
Namespace: Volo.Abp.IdentityServer.ApiResources
Assembly: Volo.Abp.IdentityServer.Domain.dll
Syntax
public class ApiScope : Entity

Constructors

ApiScope()

Declaration
protected ApiScope()

ApiScope(Guid, String, String, String, Boolean, Boolean, Boolean)

Declaration
protected ApiScope(Guid apiResourceId, string name, string displayName = null, string description = null, bool required = false, bool emphasize = false, bool showInDiscoveryDocument = true)
Parameters
Type Name Description
System.Guid apiResourceId
System.String name
System.String displayName
System.String description
System.Boolean required
System.Boolean emphasize
System.Boolean showInDiscoveryDocument

Properties

ApiResourceId

Declaration
public virtual Guid ApiResourceId { get; protected set; }
Property Value
Type Description
System.Guid

Description

Declaration
public virtual string Description { get; set; }
Property Value
Type Description
System.String

DisplayName

Declaration
public virtual string DisplayName { get; set; }
Property Value
Type Description
System.String

Emphasize

Declaration
public virtual bool Emphasize { get; set; }
Property Value
Type Description
System.Boolean

Name

Declaration
public virtual string Name { get; protected set; }
Property Value
Type Description
System.String

Required

Declaration
public virtual bool Required { get; set; }
Property Value
Type Description
System.Boolean

ShowInDiscoveryDocument

Declaration
public virtual bool ShowInDiscoveryDocument { get; set; }
Property Value
Type Description
System.Boolean

UserClaims

Declaration
public virtual List<ApiScopeClaim> UserClaims { get; protected set; }
Property Value
Type Description
System.Collections.Generic.List<ApiScopeClaim>

Methods

AddUserClaim(String)

Declaration
public virtual void AddUserClaim(string type)
Parameters
Type Name Description
System.String type

Equals(Guid, String)

Declaration
public virtual bool Equals(Guid apiResourceId, string name)
Parameters
Type Name Description
System.Guid apiResourceId
System.String name
Returns
Type Description
System.Boolean

FindClaim(String)

Declaration
public virtual ApiScopeClaim FindClaim(string type)
Parameters
Type Name Description
System.String type
Returns
Type Description
ApiScopeClaim

GetKeys()

Declaration
public override object[] GetKeys()
Returns
Type Description
System.Object[]

RemoveAllUserClaims()

Declaration
public virtual void RemoveAllUserClaims()

RemoveClaim(String)

Declaration
public virtual void RemoveClaim(string type)
Parameters
Type Name Description
System.String type

Extension Methods