Returns both Board Security profile groups with their shared row version.
GET
/api/workspace/admin/boards/boards/{boardId}/security
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/boards/boards/example/security"),};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/boards/boards/example/security';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/admin/boards/boards/example/securityAuthorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”boardId
required
string
Query Parameters
Section titled “Query Parameters”access_token
string
Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
Media typeapplication/json
object
Data
Returns the complete Board Security configuration with one shared concurrency token.
object
RowVersion
required
string format: uuid
Profiles
required
Array<object>
Returns the current artifacts for one Board resource kind.
object
ResourceKind
required
string
SecurityStatements
required
Array<object>
Describes one current Entity Security Statement.
object
Key
required
string
Source
required
string
Enabled
required
boolean
RowVersion
required
string format: uuid
PermissionAssignments
required
Array<object>
Describes one direct Permission Assignment.
object
Key
required
string
PermissionId
required
string
StatementKey
required
string
RowVersion
required
string format: uuid
Responsibilities
required
Array<object>
Describes one Responsibility Definition.
object
Key
required
string
SubjectMode
required
string
Cardinality
required
string
Required
required
boolean
FutureScheduling
required
boolean
EligibleResponsibilityGroupKeys
required
Array<string>
Enabled
required
boolean
RowVersion
required
string format: uuid
InitialAssignmentRules
required
Array<object>
Describes one initial responsibility rule.
object
Key
required
string
ResponsibilityKey
required
string
SubjectSource
required
string
SubjectKey
string
Enabled
required
boolean
RowVersion
required
string format: uuid
AssignmentRules
required
Array<object>
Describes one responsibility assignment rule.
object
Key
required
string
ResponsibilityKey
required
string
ActorSelectorType
required
string
ActorSelectorKey
required
string
Actions
required
Array<string>
EligibleTargets
required
Array<object>
Identifies one eligible assignment target selector.
object
SelectorType
required
string
SelectorKey
string
Enabled
required
boolean
RowVersion
required
string format: uuid
Errors
Array<object>
object
Code
required
string
Message
required
string
Target
string
Field
string
Metadata
object
key
additional properties
string
Type
integer format: int32
Severity
integer format: int32
Warnings
Array<object>
object
Code
required
string
Message
required
string
Target
string
Field
string
Metadata
object
key
additional properties
string
Type
integer format: int32
Severity
integer format: int32
Success
boolean
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Unauthorized
Media typeapplication/json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
Media typeapplication/json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}