PutOrganizationPolicy

Creates or modifies an organization policy for a principal.

put/api/org/v1/policies/{principal}

Path Parameters

• principal ^required

  A principal that is granted permissions to access resources.

  • Schema ResourceDescriptor
  • Type string
  • Minimum Length 1
  • Maximum Length 255
  • Pattern ^[a-z-]+:[A-Z0-9]+$

Query Parameters

This operation does not have query parameters.

Request Body

• Schema PolicySpec
• Type object
• Properties

  • permissions ^required

    A list of resource permissions.

    • Type array
    • Items

      A resource permission to grant.

      • Schema ResourceRelation

Responses

200 Response

The existing resource policy was modified successfully.

• Schema Policy
• Type object
• Properties

  • principal ^required

    The principal to which the resource permissions are granted.

    • Schema ResourceDescriptor

  • permissions ^required

    A list of resource permissions.

    • Type array
    • Items

      A resource permission granted to the principal.

      • Schema ResourceRelation

  • createdAt ^required

    The time when the earliest permission was granted.

    • Type string
    • Format date-time

  • updatedAt ^required

    The time when the latest permission was granted.

    • Type string
    • Format date-time

201 Response

The resource policy was created successfully.

• Schema Policy
• Type object
• Properties

  • principal ^required

    The principal to which the resource permissions are granted.

    • Schema ResourceDescriptor

  • permissions ^required

    A list of resource permissions.

    • Type array
    • Items

      A resource permission granted to the principal.

      • Schema ResourceRelation

  • createdAt ^required

    The time when the earliest permission was granted.

    • Type string
    • Format date-time

  • updatedAt ^required

    The time when the latest permission was granted.

    • Type string
    • Format date-time

400 Response

The requested operation cannot be performed because the request is malformed.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

401 Response

The requested operation cannot be performed because the request lacks valid authentication credentials.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

403 Response

The identity is not allowed to perform the requested operation for the resource involved.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

404 Response

The resource or dependent resources involved in the requested operation do not exist.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

Default Response

The requested operation failed with an error.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string