keyclonnect-node
v1.0.1
Published
Library to connect to keycloak and change realm properties using admin APIs
Readme
KeyClonnect
const keycloakConnect = new KeycloakConnector({
realm: "your_realm",
route: "your_keycloak_url",
admUsername: "your_adm_username",
admPassword: "your_adm_password"
})Users
- createUser({ first_name: string; last_name: string; username: string; email: string; attributes: string; })
- enableUser(userId: string)
- resetPassword(userId: string, tempPassword:string)
- findUserInfoByUsername(username: string)
- findUserInfoById(userId: string)
- deleteUser(userId: string)
- addRealmRoleToUser(userId: string, roleName: string)
- addResourceRoleToUser(userId: string, roleName: string, clientId: string)
Clients
- findClientInfoById(clientId: string)
- findClientInfoByName(clientName: string)
Roles
- findRealmRoleInfo(role: string)
- createRealmRole(role: string, description?: string)
- deleteRealmRole(role: string)
- findResourceRoleInfo(clientId: string, role: string)
- createResourceRole(clientId: string, role: string, description?: string)
- deleteResourceRole(clientId: string, role: string)
Groups
- findGroups()
- findGroupInfoByName(groupName: string)
- findGroupInfoById(groupId: string)
- findGroupInfoByPath(groupPath: string)
- createGroup(groupName: string)
- createSubGroup(mainGroupId: string,subGroupName: string)
- deleteGroupById(groupId: string)
Attributes
- updateUserAttributesById(userId: string,attributes: {})
- removeUserAttribute(userId: string, attributeName: string)
