Import Building Blocks

Updated on May 25, 2026
Published on Apr 7, 2024

3 minute(s) read

Prev Next

Post

/api/2.0/building-blocks/{envId}

Import Building Blocks.
Users can only import up to 50 building blocks per request.

Notice

Accessing the Policy Management APIs is through a dedicated domain/URL, according to your PlainID Tenant Location

United States (US) - https://api.us1.plainid.io

Canada (CA) - https://api.ca1.plainid.io

Europe (EU) - https://api.eu1.plainid.io

Using HTML Encoded Special Characters

Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.

Important note about headers

Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.

Headers

*Required

Header	Value	cURL Line
Accept	`text/plain;language=rego`	`-H "Accept :text/plain;language=rego"`
Content-Type	`text/plain;language=rego`	`-H "Content-Type:text/plain;language=rego"`

cURL Sample Guidelines

In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.

Security

HTTP

Type bearer

For more details about Administration API Authentication, check out the Authentication APIs documentation
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123

Path parameters

envId

string (uuid) Required

The Environment ID can be found under the Details Tab in the Environment Settings.

Query parameters

filter[authWsId]

string (uuid)

This can be found in your Authorization Workspace Settings under Workspace ID. *Required if identityWsId is not provided.

filter[identityWsId]

string (uuid)

Identity Workspace ID. *Required if authWsId is not provided.

extendedSchema

boolean

Toggle to enable or disable additional metadata in the response, like the Building Block id and description.

Defaulttrue

Body parameters

Building Blocks as Rego code

package building_blocks
import rego.v1

# METADATA
# custom:
#   plainid:
#     kind: DynamicGroup
#     name: dg1
#     description: dg1
dynamic_group(identity) if {
  identity.template == "idWs1"
  identity["idAttr1"] == "test"
  identity["idAttr1"] != "prod"
}

Generic Conditions

package building_blocks
import rego.v1

# METADATA
# custom:
#   plainid:
#     kind: Condition
#     subKind: Country Codes
#     name: Albania_Austria_Australia
condition(requestParams) if {
  requestParams["CountryCode"] in ["Albania", "Austria", "Australia"]
}

# METADATA
# custom:
#   plainid:
#     kind: Condition
#     subKind: Platforms
#     name: Windows Only
condition(requestParams) if {
  requestParams["Platform"] == "Windows"
}

string

Building Blocks as Rego code

Responses

201

successful operation

Headers

x-request-id

string

Successful Import

package building_blocks
import rego.v1

# METADATA
# custom:
#   plainid:
#     kind: DynamicGroup
#     name: dg1
#     id: f28c17c2-caeb-4cf2-a549-02bf03fe4e17
#     description: dg1
dynamic_group(identity) if {
  identity.template == "idWs1"
  identity["idAttr1"] == "test"
  identity["idAttr1"] != "prod"
}

Successful Import with Generic Conditions

package building_blocks
import rego.v1

# METADATA
# custom:
#   plainid:
#     kind: Condition
#     subKind: Country Codes
#     name: Albania_Austria_Australia
#     id: 8adc4fe8-759a-4df4-9dc1-c180c9c4a2c4
condition(requestParams) if {
  requestParams["CountryCode"] in ["Albania", "Austria", "Australia"]
}

# METADATA
# custom:
#   plainid:
#     kind: Condition
#     subKind: Platforms
#     name: Windows Only
#     id: bbb22222-2222-2222-2222-222222222222
condition(requestParams) if {
  requestParams["Platform"] == "Windows"
}

string

Building Blocks as Rego code

400

bad request

Headers

x-request-id

string

Identity WS not found

{
  "errors": [
    {
      "code": "PAC-005",
      "args": {
        "0": "67c1ffe0-a540-4662-b894-0813abcc04ec"
      },
      "id": "ERHCQC",
      "status": 400,
      "name": "IdentityWsNotFound",
      "message": "IdentityWs: [67c1ffe0-a540-4662-b894-0813abcc04ec] not found"
    }
  ]
}

No SAAS Application for Generic Conditions

{
  "errors": [
    {
      "code": "PACV-075",
      "args": {
        "0": "c5167aaf-c023-46a2-8262-3a5b103d69df"
      },
      "id": "EG7K2P",
      "status": 400,
      "name": "NoSaasApplicationForGenericConditions",
      "message": "No SAAS applications found in workspace [c5167aaf-c023-46a2-8262-3a5b103d69df]; cannot process generic conditions in building blocks"
    }
  ]
}

Expand All

object

errors

Array of object (Error)

object

code

string

status

integer

name

string

message

string

args

object

path

string

401

Unauthorized

Headers

x-request-id

string

422

Validation Failed - Invalid UUID

Headers

x-request-id

string

Invalid ID Format

{
  "errors": [
    {
      "code": "V-032",
      "args": {
        "0": "ed252aa5-9d0c-4193-838-60bf20b13109",
        "1": "uuid"
      },
      "id": "EEJQMA",
      "status": 422,
      "name": "UnprocessableEntityError",
      "message": "$: test is an invalid uuid"
    }
  ]
}

Expand All

object

errors

Array of object (Error)

object

code

string

status

integer

name

string

message

string

args

object

path

string

Was this article helpful?

Documentation Index

Import Building Blocks

Notice

Using HTML Encoded Special Characters

Important note about headers

Headers

cURL Sample Guidelines