apiclient.xyz/zitadel
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(core): update

Browse Source
This commit is contained in:
Philipp Kunz 2024-05-03 10:53:50 +02:00
parent 26dd8ac6cd
commit d7444aa901
4 changed files with 82 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
npmextra.json
View File

@ -5,7 +5,7 @@
"githost": "code.foss.global",
"gitscope": "apiclient.xyz",
"gitrepo": "zitadel",
"description": "An unofficial client for interacting with Zitadel API.",
"description": "An unofficial client for interacting with Zitadel API, enabling user and project management functionalities.",
"npmPackagename": "@apiclient.xyz/zitadel",
"license": "MIT",
"projectDomain": "apiclient.xyz",
@ -14,7 +14,12 @@
"API client",
"TypeScript",
"authentication",
"user management"
"user management",
"project management",
"unofficial client",
"node.js",
"access control",
"software development"
]
}
},

11
package.json
View File

@ -2,7 +2,7 @@
"name": "@apiclient.xyz/zitadel",
"version": "1.0.7",
"private": false,
"description": "An unofficial client for interacting with Zitadel API.",
"description": "An unofficial client for interacting with Zitadel API, enabling user and project management functionalities.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
@ -54,6 +54,11 @@
"API client",
"TypeScript",
"authentication",
"user management"
"user management",
"project management",
"unofficial client",
"node.js",
"access control",
"software development"
]
}
}

119
readme.md
View File

@ -1,15 +1,16 @@
# @apiclient.xyz/zitadel
an unofficial zitadel client
An unofficial client for interacting with Zitadel API.
## Install
To install `@apiclient.xyz/zitadel`, you need to have Node.js installed on your system. You can then add it to your project using npm with the following command:
To get started with `@apiclient.xyz/zitadel`, ensure you have Node.js installed on your machine. Then, you can add this package to your project by running:
```bash
npm install @apiclient.xyz/zitadel --save
```
Ensure you have TypeScript installed for development purposes. If you haven't, install it using:
This module is written in TypeScript to take advantage of type safety and autocompletion in IDEs. If you haven't installed TypeScript globally, you can do so by running:
```bash
npm install -g typescript
@ -17,91 +18,101 @@ npm install -g typescript
## Usage
The `@apiclient.xyz/zitadel` package provides a simplified, unofficial TypeScript client for interacting with Zitadel's APIs. This guide will walk you through setting up the client and executing various operations such as user management in a TypeScript project.
The `@apiclient.xyz/zitadel` package provides an unofficial TypeScript client for easy interaction with Zitadel's API, allowing for convenient management operations such as user and project management.
Let's get started by setting up and initializing the client in your project.
### Getting Started
### Setup and Initialization
First, import the necessary classes from the package:
First, ensure you import the core client class from the package:
```typescript
import { ZitaldelClient, ZitaldelUser } from '@apiclient.xyz/zitadel';
import { ZitaldelClient } from '@apiclient.xyz/zitadel';
```
Instantiate the `ZitaldelClient` by providing connection options, including the Zitadel instance URL and an access token:
Initialize the `ZitaldelClient` with your Zitadel instance URL and access token:
```typescript
const zitadelClient = new ZitaldelClient({
url: 'https://your-zitadel-instance.com', // Replace with your Zitadel instance URL
accessToken: 'your_access_token_here' // Replace with your actual access token
url: 'https://your-zitadel-instance.com', // Replace with your Zitadel instance URL.
accessToken: 'your_access_token_here' // Replace with your actual access token.
});
```
### Managing Users
### User Management
The Zitadel client supports various user management operations such as listing users, getting user information, and creating new users.
The library allows performing user operations such as listing all users, getting info of the current user, and creating new users.
#### Listing Users
To list users, you can use the `listUsers` method. This will return an array of `ZitaldelUser` objects:
#### List All Users
```typescript
async function listUsers() {
try {
const users = await zitadelClient.listUsers();
console.log(users);
} catch (error) {
console.error('Failed to list users:', error);
}
const users = await zitadelClient.listUsers();
console.log(users); // Outputs user list
}
listUsers();
```
#### Getting User Information
To get information about a specific user, use the `listOwnUser` method. This method is handy for fetching details about the authenticated user:
#### Get Current User Information
```typescript
async function getOwnUserInfo() {
try {
const user = await zitadelClient.listOwnUser();
console.log(user);
} catch (error) {
console.error('Failed to get user info:', error);
}
async function getCurrentUser() {
const user = await zitadelClient.listOwnUser();
console.log(user); // Outputs current user information.
}
getOwnUserInfo();
getCurrentUser();
```
#### Creating a User
To create a new user, the `createUser` method can be used. You need to provide user details such as email, first name, and last name:
#### Create a New User
```typescript
async function createUser() {
try {
await zitadelClient.createUser({
email: 'newuser@example.com',
firstName: 'John',
lastName: 'Doe'
});
console.log('User created successfully');
} catch (error) {
console.error('Failed to create user:', error);
}
await zitadelClient.createUser({
email: 'newuser@example.com',
firstName: 'First',
lastName: 'Last'
});
console.log('User created successfully.');
}
createUser();
```
### Advanced Usage
### Project Management
For more advanced scenarios, refer to the [official Zitadel documentation](https://docs.zitadel.ch/) and the source code of this package. The `@apiclient.xyz/zitadel` client provides a straightforward interface to Zitadel's API but does not cover all possible use cases and functionalities of Zitadel. You might need to extend the client or use the official Zitadel client for complex scenarios.
Beyond user management, the client also supports actions on projects—like listing and managing project roles.
## Conclusion
#### List Projects
The `@apiclient.xyz/zitadel` package makes it easier to interact with Zitadel's APIs from a TypeScript application. With it, you can manage users, handle authentication, and perform various other operations provided by Zitadel. This guide covered the basics of setting up the client, managing users, and performing some common operations. For further details or specific use cases, consult the Zitadel documentation and the package's source code.
```typescript
async function listProjects() {
const projects = await zitadelClient.listProjects();
console.log(projects); // Outputs list of projects
}
listProjects();
```
#### Project Roles
Each project comes with roles that can be managed through the client.
##### Listing Project Roles
To inspect roles within a project:
```typescript
async function listProjectRoles(projectId: string) {
const projectRoles = await someProject.listProjectRoles(); // Assume `someProject` is an instance of `ZitadelProject`.
console.log(projectRoles);
}
```
Note: The `ZitadelProject` object would typically be obtained as part of the list from `listProjects`.
### Advanced Topics
For more complex scenarios, such as direct interaction with Zitadel's gRPC APIs, or detailed configuration, please refer to the comprehensive [official Zitadel documentation](https://docs.zitadel.ch/). This client offers a simplified abstraction over Zitadel's API functionalities but can be extended or used in conjunction with direct API calls to meet specific needs.
For instance, the `ZitaldelClient` class can be tweaked to support custom interceptors for logging, authentication flow enhancements, or to integrate with Zitadel's event system for real-time updates on resources.
---
This is a basic introduction to `@apiclient.xyz/zitadel`. The client simplifies the interaction with Zitadel's API, focusing on core functionalities like user and project management. For specific use cases, detailed configurations, or advanced features, you may need to extend the client or use it as a foundation for more complex interactions with the Zitadel API.
undefined

4
ts/00_commitinfo_data.ts
View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@apiclient.xyz/zitadel',
version: '1.0.7',
description: 'An unofficial client for interacting with Zitadel API.'
version: '1.0.8',
description: 'An unofficial client for interacting with Zitadel API, enabling user and project management functionalities.'
}