Creates a workspace-role association.

POST

/api/workspace/admin/file-protection/security/associations

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/file-protection/security/associations"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"WorkspaceRoleId\": \"example\", \"InternalRoleKey\": \"example\", \"ScopeKind\": 0, \"ScopeId\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
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/file-protection/security/associations';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"WorkspaceRoleId":"example","InternalRoleKey":"example","ScopeKind":0,"ScopeId":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/admin/file-protection/security/associations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "WorkspaceRoleId": "example", "InternalRoleKey": "example", "ScopeKind": 0, "ScopeId": "example" }'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Creates a workspace-role association.

object

WorkspaceRoleId

string

nullable

InternalRoleKey

string

nullable

ScopeKind

integer format: int32

Allowed values: 0 1

ScopeId

string

nullable

Responses

200

application/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

string

nullable

Name

string

nullable

Sources

Array<object>

nullable

Logical protection source available as a security scope target.

object

string

nullable

Name

string

nullable

Associations

Array<object>

nullable

Persisted workspace-role to internal-role association.

object

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
    }
  ]
}

400

Bad Request

application/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

string

nullable

Name

string

nullable

Sources

Array<object>

nullable

Logical protection source available as a security scope target.

object

string

nullable

Name

string

nullable

Associations

Array<object>

nullable

Persisted workspace-role to internal-role association.

object

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

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

application/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

string

nullable

Name

string

nullable

Sources

Array<object>

nullable

Logical protection source available as a security scope target.

object

string

nullable

Name

string

nullable

Associations

Array<object>

nullable

Persisted workspace-role to internal-role association.

object

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
    }
  ]
}

Creates a workspace-role association.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

409

Example

Example^generated