Plan

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Plan is contained within a Registrar.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
capabilities object No
config object No
deployedApplicationAllowance number No
planKey string No
subtenantAllowance number No

Methods

The following methods are available:

Check Permission

Checks whether one or more authorities against the specified plan are granted for a given set of users
POST /registrars/{registrarId}/plans/{permissionedId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
registrarId true string
permissionedId true string
permissionId true string
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified plan for the given user
POST /registrars/{registrarId}/plans/{permissionedId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
registrarId true string
permissionedId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified plan are granted for a given set of users
POST /registrars/{registrarId}/plans/authorities/check

Parameters

Name Required Type Description
registrarId true string The ID of the registrar

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified plan are granted for a given set of users
POST /registrars/{registrarId}/plans/permissions/check

Parameters

Name Required Type Description
registrarId true string

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Create Plan

Creates a new Plan
POST /registrars/{registrarId}/plans

Parameters

Name Required Type Description
registrarId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Plan

Deletes an existing Plan
DELETE /registrars/{registrarId}/plans/{planId}

Parameters

Name Required Type Description
registrarId true string
planId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Plan

Deletes an existing Plan
POST /registrars/{registrarId}/plans/{planId}/delete

Parameters

Name Required Type Description
registrarId true string
planId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Grant Authority

Grants an authority against the specified plan to a given user
POST /registrars/{registrarId}/plans/{permissionedId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
registrarId true string
permissionedId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Lists Plan

Retrieves a list of Plan instances
GET /registrars/{registrarId}/plans

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_plan"
      }
    }
  }
}

Queries for Plan

Queries for instances of type Plan
POST /registrars/{registrarId}/plans/query

Parameters

Name Required Type Description
registrarId true string
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_plan"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified plan
GET /registrars/{registrarId}/plans/{planId}/acl/list

Parameters

Name Required Type Description
registrarId true string
planId true string

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a plan and specific actor
GET /registrars/{registrarId}/plans/{planId}/acl

Parameters

Name Required Type Description
registrarId true string
planId true string
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified plan
POST /registrars/{registrarId}/plans/{permissionedId}/authorities

Parameters

Name Required Type Description
registrarId true string
permissionedId true string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Plan

Reads an instance of a Plan
GET /registrars/{registrarId}/plans/{planId}

Parameters

Name Required Type Description
registrarId true string
planId true string

Response

{
  "type": "object",
  "extends": "document",
  "container": "registrar",
  "description": "Plan",
  "properties": {
    "planKey": {
      "type": "string"
    },
    "config": {
      "type": "object",
      "properties": {}
    },
    "capabilities": {
      "type": "object",
      "properties": {}
    },
    "subtenantAllowance": {
      "type": "number"
    },
    "deployedApplicationAllowance": {
      "type": "number"
    },
    "_doc": null,
    "_system": null
  }
}

Revoke Authority

Revokes an authority against the specified plan from a given user
POST /registrars/{registrarId}/plans/{permissionedId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
registrarId true string
permissionedId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Starts an export job for this resource

Starts an export job for this resource
POST /registrars/{registrarId}/plans/{planId}/export

Parameters

Name Required Type Description
registrarId true string
planId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /registrars/{registrarId}/plans/{planId}/import

Parameters

Name Required Type Description
registrarId true string
planId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Update Plan

Updates an existing Plan
POST /registrars/{registrarId}/plans/{planId}/update

Parameters

Name Required Type Description
registrarId true string
planId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Plan

Updates an existing Plan
PUT /registrars/{registrarId}/plans/{planId}

Parameters

Name Required Type Description
registrarId true string
planId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Schema


{
  "type": "object",
  "extends": "document",
  "container": "registrar",
  "description": "Plan",
  "properties": {
    "planKey": {
      "type": "string"
    },
    "config": {
      "type": "object",
      "properties": {}
    },
    "capabilities": {
      "type": "object",
      "properties": {}
    },
    "subtenantAllowance": {
      "type": "number"
    },
    "deployedApplicationAllowance": {
      "type": "number"
    },
    "_doc": null,
    "_system": null
  },
  "id": "plan"
}