Error

A valid request URL is required to generate request examples

{
  "attached_at": "<string>",
  "description": "<string>",
  "effect": "allow",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "attached_at": "<string>",
  "description": "<string>",
  "effect": "allow",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

Attach an access policy to a team

Attaches an existing access policy in the organization to a team. A workspace scoped team’s policy applies in its workspace. An organization-wide team’s policy applies in the workspace_id given, or in every workspace the team has access to when it is omitted. Returns 201 when the policy is attached, or 200 when it was already attached. A workspace scoped team needs workspaces:teams:manage-policies in its workspace. An organization scoped team needs organization:teams:manage-policies, and for a policy in one workspace the caller must also be a member of that workspace.

POST

/

api

/

v1

/

platform

/

orgs

/

current

/

teams

/

{team_id}

/

access-policies

Error

A valid request URL is required to generate request examples

{
  "attached_at": "<string>",
  "description": "<string>",
  "effect": "allow",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "attached_at": "<string>",
  "description": "<string>",
  "effect": "allow",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

Authorizations

X-API-Key

string

header

required

X-Organization-Id

string

header

required

Path Parameters

team_id

string<uuid>

required

Team ID

Body

application/json

access_policy_id

string<uuid>

required

workspace_id

string<uuid>

WorkspaceID limits an organization-wide team's policy to one workspace. Omit it to apply the policy in every workspace the team has access to. A workspace team's policy always applies in the team's workspace, so this must be omitted or match it.

Response

The policy was already attached

attached_at

string

required

description

string

required

effect

enum<string>

required

Available options:

allow,

deny

id

string<uuid>

required

name

string

required

workspace_id

string<uuid>

WorkspaceID is the workspace the policy applies in. It is omitted when the policy applies in every workspace an organization-wide team has access to.