Skip to content
MoltaroMoltaroMoltaro Docs

Returns the embedded security catalog and persisted role associations.

GET
/api/workspace/admin/file-protection/security
curl --request GET \
  --url https://example.com/api/workspace/admin/file-protection/security \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

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”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Embedded security catalog and persisted role associations.

object
Manifest

Applied and selected security manifest status.

object
IsHealthy
boolean
ManifestKey
string
nullable
ManifestVersion
integer format: int32
nullable
Fingerprint
string
nullable
ErrorCode
string
nullable
InternalRoles
Array<object>
nullable

One internal role from the embedded manifest.

object
Key
string
nullable
SupportedScopes
Array<integer>
nullable
Allowed values: 0 1
PermissionKeys
Array<string>
nullable
Permissions
Array<object>
nullable

One stable File Protection permission.

object
Key
string
nullable
SupportedScopes
Array<integer>
nullable
Allowed values: 0 1
Scopes
Array<object>
nullable

One selectable association scope.

object
Kind
integer format: int32
Allowed values: 0 1
RequiresTarget
boolean
WorkspaceRoles
Array<object>
nullable

Workspace role available to the association editor.

object
Id
string
nullable
Name
string
nullable
Sources
Array<object>
nullable

Logical protection source available as a security scope target.

object
Id
string
nullable
Name
string
nullable
Associations
Array<object>
nullable

Persisted workspace-role to internal-role association.

object
Id
string
nullable
WorkspaceRoleId
string
nullable
WorkspaceRoleName
string
nullable
IsWorkspaceRoleStale
boolean
InternalRoleKey
string
nullable
ScopeKind
integer format: int32
Allowed values: 0 1
ScopeId
string
nullable
Source
integer format: int32
Allowed values: 0 1
IntroducedInManifestVersion
integer format: int32
nullable
RecordedAtUtc
string format: date-time
RecordedByUserId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "InternalRoles": [
      {
        "SupportedScopes": [
          0
        ]
      }
    ],
    "Permissions": [
      {
        "SupportedScopes": [
          0
        ]
      }
    ],
    "Scopes": [
      {
        "Kind": 0
      }
    ],
    "Associations": [
      {
        "ScopeKind": 0,
        "Source": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}