@meistrari/auth-nuxt 3.24.0 → 3.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -4,11 +4,13 @@ A Nuxt module for authentication, organization management, and API key capabilit
|
|
|
4
4
|
|
|
5
5
|
## Auth Types
|
|
6
6
|
|
|
7
|
-
This SDK supports two authentication models:
|
|
7
|
+
This SDK supports two interactive authentication models:
|
|
8
8
|
|
|
9
9
|
- **Application Authentication (recommended)**: Use this for product applications that need end-user authentication and authorization scoped to a specific application. See [Application Authentication Guide](./docs/APPLICATION_AUTH.md).
|
|
10
10
|
- **First-Party Authentication**: Use this only for trusted first-party tools that interact directly with the Auth API in an administrative way, such as the Accounts Dashboard and Backoffice. See [First-Party Authentication Guide](./docs/FIRST_PARTY_AUTH.md).
|
|
11
11
|
|
|
12
|
+
For machine-to-machine authentication, use `@meistrari/auth-core` directly on the server. See the [Client Credentials Guide](https://github.com/meistrari/auth-api/blob/main/packages/core/docs/CLIENT_CREDENTIALS.md).
|
|
13
|
+
|
|
12
14
|
## Installation
|
|
13
15
|
|
|
14
16
|
```bash
|
package/dist/module.json
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AdminApplicationRecord, AdminApplicationEntitlementRecord, AdminEntitlementWithRules, AdminOrganization, AdminOrganizationSummary, AdminOrganizationTeamRecord, AdminUser, AdminUserAccess, CreateAdminApplicationEntitlementOptions, CreateAdminApplicationOptions, CreateAdminOrganizationOptions, CreateAdminOrganizationTeamOptions, GetAdminOrganizationOptions, GetAdminOrganizationsSummaryOptions, InviteAdminOrganizationUsersOptions, InviteAdminOrganizationUsersResult, ListAdminApplicationsOptions, ListAdminApplicationsResult, ListAdminOrganizationMembersOptions, ListAdminOrganizationMembersResult, ListAdminOrganizationsOptions, ListAdminOrganizationsResult, ListAdminOrganizationTeamsOptions, ListAdminOrganizationTeamsResult, ListAdminUsersOptions, ListAdminUsersResult, AdminMember, RemoveAdminMemberOptions, ResendAdminInviteOptions, SetAdminEntitlementRulesOptions, SetAdminUserApplicationRoleOptions, SetAdminUserTeamOptions, UpdateAdminEntitlementOptions, UpdateAdminMemberRoleOptions, UpdateAdminOrganizationOptions } from '@meistrari/auth-core';
|
|
1
|
+
import type { AdminApplicationRecord, AdminApplicationRole, AdminApplicationEntitlementRecord, AdminApplicationSecret, AdminEntitlementWithRules, AdminOrganization, AdminOrganizationSummary, AdminOrganizationTeamRecord, AdminUser, AdminUserAccess, CreateAdminApplicationEntitlementOptions, CreateAdminApplicationOptions, CreateAdminApplicationRoleOptions, CreateAdminApplicationSecretOptions, CreateAdminOrganizationOptions, CreateAdminOrganizationTeamOptions, CreatedAdminApplicationSecret, GetAdminOrganizationOptions, GetAdminOrganizationsSummaryOptions, InviteAdminOrganizationUsersOptions, InviteAdminOrganizationUsersResult, ListAdminApplicationsOptions, ListAdminApplicationsResult, ListAdminOrganizationMembersOptions, ListAdminOrganizationMembersResult, ListAdminOrganizationsOptions, ListAdminOrganizationsResult, ListAdminOrganizationTeamsOptions, ListAdminOrganizationTeamsResult, ListAdminUsersOptions, ListAdminUsersResult, AdminMember, RemoveAdminMemberOptions, ResendAdminInviteOptions, SetAdminEntitlementRulesOptions, SetAdminUserApplicationRoleOptions, SetAdminUserTeamOptions, UpdateAdminEntitlementOptions, UpdateAdminApplicationRoleOptions, UpdateAdminMemberRoleOptions, UpdateAdminOrganizationOptions } from '@meistrari/auth-core';
|
|
2
2
|
export interface UseTelaAdminReturn {
|
|
3
3
|
/**
|
|
4
4
|
* Lists users as a global admin, optionally with organization previews
|
|
@@ -32,6 +32,14 @@ export interface UseTelaAdminReturn {
|
|
|
32
32
|
* @returns The updated application
|
|
33
33
|
*/
|
|
34
34
|
updateApplication: (applicationId: string, options: CreateAdminApplicationOptions) => Promise<AdminApplicationRecord>;
|
|
35
|
+
/** Lists application-scoped role definitions. */
|
|
36
|
+
listApplicationRoles: (applicationId: string) => Promise<AdminApplicationRole[]>;
|
|
37
|
+
/** Creates an application-scoped role definition. */
|
|
38
|
+
createApplicationRole: (applicationId: string, options: CreateAdminApplicationRoleOptions) => Promise<AdminApplicationRole>;
|
|
39
|
+
/** Updates an application-scoped role definition. */
|
|
40
|
+
updateApplicationRole: (applicationId: string, currentName: string, options: UpdateAdminApplicationRoleOptions) => Promise<AdminApplicationRole>;
|
|
41
|
+
/** Deletes an application-scoped role definition. */
|
|
42
|
+
deleteApplicationRole: (applicationId: string, name: string) => Promise<AdminApplicationRole>;
|
|
35
43
|
/**
|
|
36
44
|
* Enables an organization for an application as a global admin.
|
|
37
45
|
* @param applicationId - ID of the application to update
|
|
@@ -39,6 +47,32 @@ export interface UseTelaAdminReturn {
|
|
|
39
47
|
* @returns The created entitlement
|
|
40
48
|
*/
|
|
41
49
|
createApplicationEntitlement: (applicationId: string, options: CreateAdminApplicationEntitlementOptions) => Promise<AdminApplicationEntitlementRecord>;
|
|
50
|
+
/**
|
|
51
|
+
* Lists client secrets for an application as a global admin.
|
|
52
|
+
* @param applicationId - ID of the application to inspect
|
|
53
|
+
* @returns Secret metadata without plaintext values
|
|
54
|
+
*/
|
|
55
|
+
listApplicationSecrets: (applicationId: string) => Promise<AdminApplicationSecret[]>;
|
|
56
|
+
/**
|
|
57
|
+
* Creates a client secret for an application as a global admin.
|
|
58
|
+
* @param applicationId - ID of the application to update
|
|
59
|
+
* @param options - Optional secret display name
|
|
60
|
+
* @returns The created secret, including the plaintext value shown only once
|
|
61
|
+
*/
|
|
62
|
+
createApplicationSecret: (applicationId: string, options?: CreateAdminApplicationSecretOptions) => Promise<CreatedAdminApplicationSecret>;
|
|
63
|
+
/**
|
|
64
|
+
* Deletes a client secret for an application as a global admin.
|
|
65
|
+
* @param applicationId - ID of the application to update
|
|
66
|
+
* @param secretId - ID of the secret to delete
|
|
67
|
+
* @returns The deleted secret metadata
|
|
68
|
+
*/
|
|
69
|
+
deleteApplicationSecret: (applicationId: string, secretId: string) => Promise<AdminApplicationSecret>;
|
|
70
|
+
/**
|
|
71
|
+
* Retires an application's service-account identity as a global admin.
|
|
72
|
+
* @param applicationId - ID of the application to update
|
|
73
|
+
* @returns The updated application
|
|
74
|
+
*/
|
|
75
|
+
retireApplicationServiceAccount: (applicationId: string) => Promise<AdminApplicationRecord>;
|
|
42
76
|
/**
|
|
43
77
|
* Fetches a single entitlement together with its ordered access rules.
|
|
44
78
|
* @param entitlementId - ID of the entitlement to fetch
|
|
@@ -18,9 +18,33 @@ export function useTelaAdmin() {
|
|
|
18
18
|
async function updateApplication(applicationId, options) {
|
|
19
19
|
return await authClient.admin.updateApplication(applicationId, options);
|
|
20
20
|
}
|
|
21
|
+
async function listApplicationRoles(applicationId) {
|
|
22
|
+
return await authClient.admin.listApplicationRoles(applicationId);
|
|
23
|
+
}
|
|
24
|
+
async function createApplicationRole(applicationId, options) {
|
|
25
|
+
return await authClient.admin.createApplicationRole(applicationId, options);
|
|
26
|
+
}
|
|
27
|
+
async function updateApplicationRole(applicationId, currentName, options) {
|
|
28
|
+
return await authClient.admin.updateApplicationRole(applicationId, currentName, options);
|
|
29
|
+
}
|
|
30
|
+
async function deleteApplicationRole(applicationId, name) {
|
|
31
|
+
return await authClient.admin.deleteApplicationRole(applicationId, name);
|
|
32
|
+
}
|
|
21
33
|
async function createApplicationEntitlement(applicationId, options) {
|
|
22
34
|
return await authClient.admin.createApplicationEntitlement(applicationId, options);
|
|
23
35
|
}
|
|
36
|
+
async function listApplicationSecrets(applicationId) {
|
|
37
|
+
return await authClient.admin.listApplicationSecrets(applicationId);
|
|
38
|
+
}
|
|
39
|
+
async function createApplicationSecret(applicationId, options) {
|
|
40
|
+
return await authClient.admin.createApplicationSecret(applicationId, options);
|
|
41
|
+
}
|
|
42
|
+
async function deleteApplicationSecret(applicationId, secretId) {
|
|
43
|
+
return await authClient.admin.deleteApplicationSecret(applicationId, secretId);
|
|
44
|
+
}
|
|
45
|
+
async function retireApplicationServiceAccount(applicationId) {
|
|
46
|
+
return await authClient.admin.retireApplicationServiceAccount(applicationId);
|
|
47
|
+
}
|
|
24
48
|
async function listOrganizations(options) {
|
|
25
49
|
return await authClient.admin.listOrganizations(options);
|
|
26
50
|
}
|
|
@@ -96,7 +120,15 @@ export function useTelaAdmin() {
|
|
|
96
120
|
listApplications,
|
|
97
121
|
createApplication,
|
|
98
122
|
updateApplication,
|
|
123
|
+
listApplicationRoles,
|
|
124
|
+
createApplicationRole,
|
|
125
|
+
updateApplicationRole,
|
|
126
|
+
deleteApplicationRole,
|
|
99
127
|
createApplicationEntitlement,
|
|
128
|
+
listApplicationSecrets,
|
|
129
|
+
createApplicationSecret,
|
|
130
|
+
deleteApplicationSecret,
|
|
131
|
+
retireApplicationServiceAccount,
|
|
100
132
|
getEntitlement,
|
|
101
133
|
setEntitlementRules,
|
|
102
134
|
updateEntitlement,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@meistrari/auth-nuxt",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.26.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": {
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"docs": "nuxt-module-build prepare && typedoc"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@meistrari/auth-core": "1.
|
|
39
|
+
"@meistrari/auth-core": "1.36.0",
|
|
40
40
|
"jose": "6.1.3"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|