Skip to main content

Update a permission group

PATCH 

/auth/permission_groups/:id

Updates the specified permission group with the parameters passed. Any parameters not included in the request will be left unchanged.

Request

Path Parameters

    id stringrequired

    The id of the Permission Group

Body

required

    description stringrequired

    Human readable identifier.

    actions string[]required
    resource_groups string[]required

Responses

200: Successful response

Schema

    data

    object

    id string

    uuid.

    description string

    Human readable identifier.

    actions string[]
    resource_groups string[]
    record_type string

    Record type.

    created_at string

    Timestamp of resource creation.

    updated_at string

    Timestamp of last resource update.

401: Authentication error

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

403: Authorization error

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

404: Resource not found

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

422: Invalid parameters supplied in request. See HTTP response body for details.

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

Loading...