Class ScopeDefinition

The scope definition object is meant to be provided via headers to xperiflow client rest services for scope level control of roles and permissions. Please see concrete implementations of the Workspace.XBR.Xperiflow.Core.Scope.IScopeBuilder object for how to properly build a xperiflow compatible ScopeDefinition.

Namespace: Workspace.XBR.Xperiflow.Core.Scope

Assembly: Xperiflow.dll

Declaration

public class ScopeDefinition

Properties

Name

The scope name. This is expected to be in a specific format that is accepted by xperiflow. Ex: xperiflow/solution/{appToken}

Declaration

[JsonProperty("scope_name", Required = Required.Always)]
public string Name { get; set; }

Description

An optional scope description.

Declaration

[JsonProperty("scope_description", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string Description { get; set; }

Metadata

Any arbitrary metadata that should be associated with this scope.

Declaration

[JsonProperty("scope_metadata", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public JObject Metadata { get; set; }

Methods

ToJson()

Serialize this scope to a json string.

Declaration

public string ToJson()

Returns

System.String

FromJson(string)

Deserialize a json string into a ScopeDefinition object.

Declaration

public static ScopeDefinition FromJson(string data)

Returns

Workspace.XBR.Xperiflow.Core.Scope.ScopeDefinition

Parameters

Type	Name
System.String	data

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString