Skip to main content
Kinetic Community

Security Policy Definitions

Operation List

GET /kapps/{kappSlug}/securityPolicyDefinitions Retrieve Security Policy Definitions
POST /kapps/{kappSlug}/securityPolicyDefinitions Create Security Policy Definition
GET /kapps/{kappSlug}/securityPolicyDefinitions/{name} Retrieve Security Policy Definition
PUT /kapps/{kappSlug}/securityPolicyDefinitions/{name} Update Security Policy Definition
DELETE /kapps/{kappSlug}/securityPolicyDefinitions/{name} Delete Security Policy Definition

Resource Schema

Available Includes

  • details
  • kapp
  • securityPolicies

Operations

Retrieve Security Policy Definitions

GET /kapps/{kappSlug}/securityPolicyDefinitions

Returns information about all Security Policy Definitions for the specified Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the security policy definition belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "securityPolicyDefinitions": [
    {
      "message": "Must be a member of the Administrators group to access this resource.",
      "name": "Member of Administrators Group",
      "rule": "${identity.memberOf('Administrators')}",
      "type": "Form"
    }
  ]
}

Create Security Policy Definition

POST /kapps/{kappSlug}/securityPolicyDefinitions

Creates a new security policy definition for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the security policy definition belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "message": "Must be a member of the Administrators group to access this resource.",
  "name": "Member of Administrators Group",
  "rule": "${identity.memberOf('Administrators')}",
  "type": "Form"
}

Response

Body
{
  "securityPolicyDefinition": {
    "message": "Must be a member of the Administrators group to access this resource.",
    "name": "Member of Administrators Group",
    "rule": "${identity.memberOf('Administrators')}",
    "type": "Form"
  }
}

Retrieve Security Policy Definition

GET /kapps/{kappSlug}/securityPolicyDefinitions/{name}

Retrieves the Security Policy Definition identified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the security policy definition belongs to.

name

The name of the security policy definition to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "securityPolicyDefinition": {
    "message": "Must be a member of the Administrators group to access this resource.",
    "name": "Member of Administrators Group",
    "rule": "${identity.memberOf('Administrators')}",
    "type": "Form"
  }
}

Update Security Policy Definition

PUT /kapps/{kappSlug}/securityPolicyDefinitions/{name}

Updates the Security Policy Definition specified by the {name} parameter with the property values sent in the request body.

NOTE All properties in the request body are optional, and only the properties supplied will be updated.

Request

Path Parameters
kappSlug

The slug of the Kapp that the security policy definitoin belongs to.

name

The name of the security policy definition to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "message": "Must be a member of the Administrators group to access this resource.",
  "name": "Member of Administrators Group",
  "rule": "${identity.memberOf('Administrators')}",
  "type": "Form"
}

Response

Body
{
  "securityPolicyDefinition": {
    "message": "Must be a member of the Administrators group to access this resource.",
    "name": "Member of Administrators Group",
    "rule": "${identity.memberOf('Administrators')}",
    "type": "Form"
  }
}

Delete Security Policy Definition

DELETE /kapps/{kappSlug}/securityPolicyDefinitions/{name}

Deletes the Security Policy Definition specified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the security policy definition belongs to.

name

The name of the security policy definition to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "securityPolicyDefinition": {
    "message": "Must be a member of the Administrators group to access this resource.",
    "name": "Member of Administrators Group",
    "rule": "${identity.memberOf('Administrators')}",
    "type": "Form"
  }
}

 

Related