Class ApiResource

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

Constructors

ApiResource()

Declaration
protected ApiResource()

ApiResource(Guid, string, string, string)

Declaration
public ApiResource(Guid id, string name, string displayName = null, string description = null)
Parameters
Type Name Description
Guid id
string name
string displayName
string description

Properties

AllowedAccessTokenSigningAlgorithms

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

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

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<ApiResourceProperty> Properties { get; protected set; }
Property Value
Type Description
List<ApiResourceProperty>

Scopes

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

Secrets

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

ShowInDiscoveryDocument

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

UserClaims

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

Methods

AddProperty(string, string)

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

AddScope(string)

Declaration
public virtual ApiResourceScope AddScope(string scope)
Parameters
Type Name Description
string scope
Returns
Type Description
ApiResourceScope

AddSecret(string, DateTime?, string, string)

Declaration
public virtual void AddSecret(string value, DateTime? expiration = null, string type = "SharedSecret", string description = null)
Parameters
Type Name Description
string value
DateTime? expiration
string type
string description

AddUserClaim(string)

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

FindClaim(string)

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

FindProperty(string)

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

FindScope(string)

Declaration
public virtual ApiResourceScope FindScope(string scope)
Parameters
Type Name Description
string scope
Returns
Type Description
ApiResourceScope

FindSecret(string, string)

Declaration
public virtual ApiResourceSecret FindSecret(string value, string type = "SharedSecret")
Parameters
Type Name Description
string value
string type
Returns
Type Description
ApiResourceSecret

RemoveAllProperties()

Declaration
public virtual void RemoveAllProperties()

RemoveAllScopes()

Declaration
public virtual void RemoveAllScopes()

RemoveAllSecrets()

Declaration
public virtual void RemoveAllSecrets()

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

RemoveScope(string)

Declaration
public virtual void RemoveScope(string scope)
Parameters
Type Name Description
string scope

RemoveSecret(string, string)

Declaration
public virtual void RemoveSecret(string value, string type = "SharedSecret")
Parameters
Type Name Description
string value
string type

Implements

Extension Methods