Class ApiScope

Inheritance
object
Entity
Entity<Guid>
BasicAggregateRoot<Guid>
AggregateRoot<Guid>
CreationAuditedAggregateRoot<Guid>
AuditedAggregateRoot<Guid>
FullAuditedAggregateRoot<Guid>
ApiScope
Implements
Inherited Members
Namespace: Volo.Abp.IdentityServer.ApiScopes
Assembly: Volo.Abp.IdentityServer.Domain.dll
Syntax
public class ApiScope : FullAuditedAggregateRoot<Guid>, IAggregateRoot<Guid>, IEntity<Guid>, IAggregateRoot, IEntity, IGeneratesDomainEvents, IHasExtraProperties, IHasConcurrencyStamp, IFullAuditedObject, IAuditedObject, ICreationAuditedObject, IHasCreationTime, IMayHaveCreator, IModificationAuditedObject, IHasModificationTime, IDeletionAuditedObject, IHasDeletionTime, ISoftDelete

Constructors

ApiScope()

Declaration
protected ApiScope()

ApiScope(Guid, string, string, string, bool, bool, bool, bool)

Declaration
public ApiScope(Guid id, string name, string displayName = null, string description = null, bool required = false, bool emphasize = false, bool showInDiscoveryDocument = true, bool enabled = true)
Parameters
Type Name Description
Guid id
string name
string displayName
string description
bool required
bool emphasize
bool showInDiscoveryDocument
bool enabled

Properties

Description

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

DisplayName

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

Emphasize

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

Enabled

Declaration
public virtual bool Enabled { get; set; }
Property Value
Type Description
bool

Name

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

Properties

Declaration
public virtual List<ApiScopeProperty> Properties { get; protected set; }
Property Value
Type Description
List<ApiScopeProperty>

Required

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

ShowInDiscoveryDocument

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

UserClaims

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

Methods

AddProperty(string, string)

Declaration
public virtual void AddProperty(string key, string value)
Parameters
Type Name Description
string key
string value

AddUserClaim(string)

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

FindClaim(string)

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

FindProperty(string)

Declaration
public virtual ApiScopeProperty FindProperty(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ApiScopeProperty

RemoveAllProperties()

Declaration
public virtual void RemoveAllProperties()

RemoveAllUserClaims()

Declaration
public virtual void RemoveAllUserClaims()

RemoveClaim(string)

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

RemoveProperty(string)

Declaration
public virtual void RemoveProperty(string key)
Parameters
Type Name Description
string key

Implements

Extension Methods