Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 2.71 KB

Group.md

File metadata and controls

114 lines (78 loc) · 2.71 KB

Group Management

CRUD operations over Group.

Get Group

ID: com.fireblink.fbl.plugins.keycloak.admin.client.group.get

Aliases:

  • fbl.plugins.keycloak.admin.client.group.get
  • keycloak.group.get

Example

keycloak.group.get:
  # [required] Credentials to authenticate with, check ./Credentials.md for more information
  credentials: $ref:secrets.keycloak.credentials

  # [required] Realm name
  realmName: master

  # [required] Group name
  groupName: admins

  # [optional] Assign group to context
  # Follows common assign logic practices https://fbl.fireblink.com/plugins/common#assign-to
  assignGroupTo: $.ctx.group

  # [optional] Push group to context
  # Follows common push logic practices https://fbl.fireblink.com/plugins/common#push-to
  pushGroupTo: $.ctx.groups

Create Group

ID: com.fireblink.fbl.plugins.keycloak.admin.client.group.create

Aliases:

  • fbl.plugins.keycloak.admin.client.group.create
  • keycloak.group.create

Example

keycloak.group.create:
  # [required] Credentials to authenticate with, check ./Credentials.md for more information
  credentials: $ref:secrets.keycloak.credentials

  # [required] Realm name
  realmName: master

  # [required] Group representation
  group:
    # [required] Group name
    name: admins
    # [optional] other group fields - https://www.keycloak.org/docs-api/6.0/rest-api/index.html#_grouprepresentation
    # Note: `clientRoles` and `realmRoles` have no affect upon creation and will be ignored

Update Group

ID: com.fireblink.fbl.plugins.keycloak.admin.client.group.update

Aliases:

  • fbl.plugins.keycloak.admin.client.group.update
  • keycloak.group.update

Example

keycloak.group.update:
  # [required] Credentials to authenticate with, check ./Credentials.md for more information
  credentials: $ref:secrets.keycloak.credentials

  # [required] Realm name
  realmName: realm-name

  # [required] Group name
  groupName: admins

  # [required] Group representation
  group:
    # [required] Group name
    name: super-admins
    # [optional] other group fields - https://www.keycloak.org/docs-api/6.0/rest-api/index.html#_grouprepresentation
    # Note: `clientRoles` and `realmRoles` have no affect upon creation and will be ignored

Delete Group

ID: com.fireblink.fbl.plugins.keycloak.admin.client.group.delete

Aliases:

  • fbl.plugins.keycloak.admin.client.group.delete
  • keycloak.group.delete

Example

keycloak.group.delete:
  # [required] Credentials to authenticate with, check ./Credentials.md for more information
  credentials: $ref:secrets.keycloak.credentials

  # [required] Realm name
  realmName: realm-name

  # [required] Group name
  groupName: admins