Skip to main content

Get Permission Group

GET 
/v1/permissions/:permissionGroupId

This endpoint returns the metadata of a Permission Group identified by the permissionGroupId.

Request​

Path Parameters

    permissionGroupId int64required

    The identifier of the Permission Group.

Responses​

When everything is ok, the permission group data returned.

Schema

    permissionGroupId int64

    Identifier of the Permission Group.

    name stringnullable

    Name of the Permission Group.

    canManageMembers boolean

    Group members can manage team members.

    canCreateOrUpdateConfig boolean

    Group members can create/update Configs.

    canDeleteConfig boolean

    Group members can delete Configs.

    canCreateOrUpdateEnvironment boolean

    Group members can create/update Environments.

    canDeleteEnvironment boolean

    Group members can delete Environments.

    canCreateOrUpdateSetting boolean

    Group members can create/update Feature Flags and Settings.

    canTagSetting boolean

    Group members can attach/detach Tags to Feature Flags and Settings.

    canDeleteSetting boolean

    Group members can delete Feature Flags and Settings.

    canCreateOrUpdateTag boolean

    Group members can create/update Tags.

    canDeleteTag boolean

    Group members can delete Tags.

    canManageWebhook boolean

    Group members can create/update/delete Webhooks.

    canUseExportImport boolean

    Group members can use the export/import feature.

    canManageProductPreferences boolean

    Group members can update Product preferences.

    canManageIntegrations boolean

    Group members can add and configure integrations.

    canViewSdkKey boolean

    Group members has access to SDK keys.

    canRotateSdkKey boolean

    Group members can rotate SDK keys.

    canCreateOrUpdateSegments boolean

    Group members can create/update Segments.

    canDeleteSegments boolean

    Group members can delete Segments.

    canViewProductAuditLog boolean

    Group members has access to audit logs.

    canViewProductStatistics boolean

    Group members has access to product statistics.

    canDisable2FA boolean

    Group members can disable two-factor authentication for other members.

    accessType AccessType (string)

    Possible values: [readOnly, full, custom]

    Represent the Feature Management permission.

    newEnvironmentAccessType EnvironmentAccessType (string)

    Possible values: [full, readOnly, none]

    Represent the environment specific Feature Management permission.

    environmentAccesses

    object[]

    nullable

    List of environment specific permissions.

  • Array [

    • environmentId uuid

    Identifier of the Environment.

    name stringnullable

    Name of the Environment.

    color stringnullable

    Color of the Environment.

    description stringnullable

    Description of the Environment.

    order int32

    The order of the Environment represented on the ConfigCat Dashboard.

    reasonRequired boolean

    Determines whether a mandatory reason must be given every time when the Feature Flags or Settings in the given Environment are saved.

    environmentAccessType EnvironmentAccessType (string)

    Possible values: [full, readOnly, none]

    Represent the environment specific Feature Management permission.

  • ]

    • product

    object

    Details of the Product.

    organization

    object

    Details of the Organization.

    organizationId uuid

    Identifier of the Organization.

    name stringnullable

    Name of the Organization.

    productId uuid

    Identifier of the Product.

    name stringnullable

    Name of the Product.

    description stringnullable

    Description of the Product.

    order int32

    The order of the Product represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.

    reasonRequired boolean

    Determines whether a mandatory reason must be given every time when the Feature Flags or Settings within a Product are saved.

Loading...