Class ApiResource

Inheritance
System.Object
ApiResource
Namespace: Volo.Abp.IdentityServer.ApiResources
Assembly: Volo.Abp.IdentityServer.Domain.dll
Syntax
public class ApiResource : FullAuditedAggregateRoot<Guid>

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
System.Guid id
System.String name
System.String displayName
System.String description

Properties

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

Enabled

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

Name

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

Properties

Declaration
public virtual Dictionary<string, string> Properties { get; protected set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.String>

Scopes

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

Secrets

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

UserClaims

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

Methods

AddScope(String, String, String, Boolean, Boolean, Boolean)

Declaration
public virtual ApiScope AddScope(string name, string displayName = null, string description = null, bool required = false, bool emphasize = false, bool showInDiscoveryDocument = true)
Parameters
Type Name Description
System.String name
System.String displayName
System.String description
System.Boolean required
System.Boolean emphasize
System.Boolean showInDiscoveryDocument
Returns
Type Description
ApiScope

AddSecret(String, Nullable<DateTime>, String, String)

Declaration
public virtual void AddSecret(string value, DateTime? expiration = default(DateTime? ), string type = null, string description = null)
Parameters
Type Name Description
System.String value
System.Nullable<System.DateTime> expiration
System.String type
System.String description

AddUserClaim(String)

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

FindClaim(String)

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

FindScope(String)

Declaration
public virtual ApiScope FindScope(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
ApiScope

FindSecret(String, String)

Declaration
public virtual ApiSecret FindSecret(string value, string type = null)
Parameters
Type Name Description
System.String value
System.String type
Returns
Type Description
ApiSecret

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
System.String type

RemoveScope(String)

Declaration
public virtual void RemoveScope(string name)
Parameters
Type Name Description
System.String name

RemoveSecret(String, String)

Declaration
public virtual void RemoveSecret(string value, string type = null)
Parameters
Type Name Description
System.String value
System.String type

Extension Methods