@keycloak/keycloak-admin-client 16.0.0-dev.9 → 17.0.0-dev.1

package/lib/resources/clients.d.ts

@@ -14,11 +14,14 @@ import GlobalRequestResult from '../defs/globalRequestResult';
 import Resource from './resource';
 import CertificateRepresentation from '../defs/certificateRepresentation';
 import KeyStoreConfig from '../defs/keystoreConfig';
+import ResourceServerRepresentation from '../defs/resourceServerRepresentation';
+import ScopeRepresentation from '../defs/scopeRepresentation';
 export interface ClientQuery {
     first?: number;
     max?: number;
     clientId?: string;
     viewableOnly?: boolean;
+    search?: boolean;
 }
 export interface PolicyQuery {
     id?: string;
@@ -35,460 +38,522 @@ export interface PolicyQuery {
 export declare class Clients extends Resource<{
     realm?: string;
 }> {
-    find: (payload?: ClientQuery & {
-        realm?: string;
-    }) => Promise<ClientRepresentation[]>;
-    create: (payload?: ClientRepresentation & {
-        realm?: string;
-    }) => Promise<{
+    find: (payload?: (ClientQuery & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ClientRepresentation[]>;
+    create: (payload?: (ClientRepresentation & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<{
         id: string;
     }>;
-    findOne: (payload?: {
+    findOne: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<ClientRepresentation>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<ClientRepresentation | undefined>;
     update: (query: {
         id: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: ClientRepresentation) => Promise<void>;
-    del: (payload?: {
+    del: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    createRole: (payload?: RoleRepresentation & {
-        realm?: string;
-    }) => Promise<{
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    createRole: (payload?: (RoleRepresentation & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<{
         roleName: string;
     }>;
-    listRoles: (payload?: {
+    listRoles: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation[]>;
-    findRole: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation[]>;
+    findRole: (payload?: ({
         id: string;
         roleName: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation>;
     updateRole: (query: {
         id: string;
         roleName: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: RoleRepresentation) => Promise<void>;
-    delRole: (payload?: {
+    delRole: (payload?: ({
         id: string;
         roleName: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    findUsersWithRole: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    findUsersWithRole: (payload?: ({
         id: string;
         roleName: string;
-        first?: number;
-        max?: number;
+        first?: number | undefined;
+        max?: number | undefined;
     } & {
-        realm?: string;
-    }) => Promise<UserRepresentation[]>;
-    getServiceAccountUser: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<UserRepresentation[]>;
+    getServiceAccountUser: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<UserRepresentation>;
-    generateNewClientSecret: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<UserRepresentation>;
+    generateNewClientSecret: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<CredentialRepresentation>;
-    generateRegistrationAccessToken: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<CredentialRepresentation>;
+    generateRegistrationAccessToken: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<{
+        realm?: string | undefined;
+    }) | undefined) => Promise<{
         registrationAccessToken: string;
     }>;
-    getClientSecret: (payload?: {
+    getClientSecret: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<CredentialRepresentation>;
-    listDefaultClientScopes: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<CredentialRepresentation>;
+    listDefaultClientScopes: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<ClientScopeRepresentation[]>;
-    addDefaultClientScope: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ClientScopeRepresentation[]>;
+    addDefaultClientScope: (payload?: ({
         id: string;
         clientScopeId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    delDefaultClientScope: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    delDefaultClientScope: (payload?: ({
         id: string;
         clientScopeId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    listOptionalClientScopes: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    listOptionalClientScopes: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<ClientScopeRepresentation[]>;
-    addOptionalClientScope: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ClientScopeRepresentation[]>;
+    addOptionalClientScope: (payload?: ({
         id: string;
         clientScopeId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    delOptionalClientScope: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    delOptionalClientScope: (payload?: ({
         id: string;
         clientScopeId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
     addMultipleProtocolMappers: (query: {
         id: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: ProtocolMapperRepresentation[]) => Promise<void>;
     addProtocolMapper: (query: {
         id: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: ProtocolMapperRepresentation) => Promise<void>;
-    listProtocolMappers: (payload?: {
+    listProtocolMappers: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<ProtocolMapperRepresentation[]>;
-    findProtocolMapperById: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ProtocolMapperRepresentation[]>;
+    findProtocolMapperById: (payload?: ({
         id: string;
         mapperId: string;
     } & {
-        realm?: string;
-    }) => Promise<ProtocolMapperRepresentation>;
-    findProtocolMappersByProtocol: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ProtocolMapperRepresentation>;
+    findProtocolMappersByProtocol: (payload?: ({
         id: string;
         protocol: string;
     } & {
-        realm?: string;
-    }) => Promise<ProtocolMapperRepresentation[]>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<ProtocolMapperRepresentation[]>;
     updateProtocolMapper: (query: {
         id: string;
         mapperId: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: ProtocolMapperRepresentation) => Promise<void>;
-    delProtocolMapper: (payload?: {
+    delProtocolMapper: (payload?: ({
         id: string;
         mapperId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    listScopeMappings: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    listScopeMappings: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<MappingsRepresentation>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<MappingsRepresentation>;
     addClientScopeMappings: (query: {
         id: string;
         client: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: RoleRepresentation[]) => Promise<void>;
-    listClientScopeMappings: (payload?: {
+    listClientScopeMappings: (payload?: ({
         id: string;
         client: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation[]>;
-    listAvailableClientScopeMappings: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation[]>;
+    listAvailableClientScopeMappings: (payload?: ({
         id: string;
         client: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation[]>;
-    listCompositeClientScopeMappings: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation[]>;
+    listCompositeClientScopeMappings: (payload?: ({
         id: string;
         client: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation[]>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation[]>;
     delClientScopeMappings: (query: {
         id: string;
         client: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: RoleRepresentation[]) => Promise<void>;
-    evaluatePermission: (payload?: {
+    evaluatePermission: (payload?: ({
         id: string;
         roleContainer: string;
         type: 'granted' | 'not-granted';
         scope: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation[]>;
-    evaluateListProtocolMapper: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation[]>;
+    evaluateListProtocolMapper: (payload?: ({
         id: string;
         scope: string;
     } & {
-        realm?: string;
-    }) => Promise<ProtocolMapperRepresentation[]>;
-    evaluateGenerateAccessToken: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ProtocolMapperRepresentation[]>;
+    evaluateGenerateAccessToken: (payload?: ({
         id: string;
         scope: string;
         userId: string;
     } & {
-        realm?: string;
-    }) => Promise<object>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<object>;
     addRealmScopeMappings: (query: {
         id: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: RoleRepresentation[]) => Promise<void>;
-    listRealmScopeMappings: (payload?: {
+    listRealmScopeMappings: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation[]>;
-    listAvailableRealmScopeMappings: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation[]>;
+    listAvailableRealmScopeMappings: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation[]>;
-    listCompositeRealmScopeMappings: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation[]>;
+    listCompositeRealmScopeMappings: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<RoleRepresentation[]>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<RoleRepresentation[]>;
     delRealmScopeMappings: (query: {
         id: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: RoleRepresentation[]) => Promise<void>;
-    listSessions: (payload?: {
+    listSessions: (payload?: ({
         id: string;
-        first?: number;
-        max?: number;
+        first?: number | undefined;
+        max?: number | undefined;
     } & {
-        realm?: string;
-    }) => Promise<UserSessionRepresentation[]>;
-    listOfflineSessions: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<UserSessionRepresentation[]>;
+    listOfflineSessions: (payload?: ({
         id: string;
-        first?: number;
-        max?: number;
+        first?: number | undefined;
+        max?: number | undefined;
     } & {
-        realm?: string;
-    }) => Promise<UserSessionRepresentation[]>;
-    getSessionCount: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<UserSessionRepresentation[]>;
+    getSessionCount: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<{
+        realm?: string | undefined;
+    }) | undefined) => Promise<{
         count: number;
     }>;
-    listResources: (payload?: {
+    getResourceServer: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<ResourceRepresentation[]>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<ResourceServerRepresentation>;
+    updateResourceServer: (query: {
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }, payload: ResourceServerRepresentation) => Promise<void>;
+    listResources: (payload?: ({
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ResourceRepresentation[]>;
     createResource: (query: {
         id: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: ResourceRepresentation) => Promise<ResourceRepresentation>;
+    getResource: (payload?: ({
+        id: string;
+        resourceId: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ResourceRepresentation>;
     updateResource: (query: {
         id: string;
         resourceId: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: ResourceRepresentation) => Promise<void>;
-    delResource: (payload?: {
+    delResource: (payload?: ({
         id: string;
         resourceId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    importResource: (query: {
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }, payload: ResourceServerRepresentation) => Promise<any>;
+    exportResource: (payload?: ({
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<any>;
     evaluateResource: (query: {
         id: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: ResourceEvaluation) => Promise<any>;
-    listPolicies: (payload?: PolicyQuery & {
-        realm?: string;
-    }) => Promise<PolicyRepresentation[]>;
-    findPolicyByName: (payload?: {
+    listPolicies: (payload?: (PolicyQuery & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<PolicyRepresentation[]>;
+    findPolicyByName: (payload?: ({
         id: string;
         name: string;
     } & {
-        realm?: string;
-    }) => Promise<PolicyRepresentation>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<PolicyRepresentation>;
     updatePolicy: (query: {
         id: string;
         type: string;
         policyId: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: PolicyRepresentation) => Promise<void>;
     createPolicy: (query: {
         id: string;
         type: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: PolicyRepresentation) => Promise<PolicyRepresentation>;
-    findOnePolicy: (payload?: {
+    findOnePolicy: (payload?: ({
         id: string;
         type: string;
         policyId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    delPolicy: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    delPolicy: (payload?: ({
         id: string;
         policyId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
     createOrUpdatePolicy(payload: {
         id: string;
         policyName: string;
         policy: PolicyRepresentation;
     }): Promise<PolicyRepresentation>;
-    listAllScopes: (payload?: {
+    listAllScopes: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<any>;
-    listScopesByResource: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ScopeRepresentation[]>;
+    listAllResourcesByScope: (payload?: ({
+        id: string;
+        scopeId: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ResourceRepresentation[]>;
+    listAllPermissionsByScope: (payload?: ({
+        id: string;
+        scopeId: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<PolicyRepresentation[]>;
+    listPermissionsByResource: (payload?: ({
+        id: string;
+        resourceId: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<ResourceServerRepresentation[]>;
+    listScopesByResource: (payload?: ({
         id: string;
         resourceName: string;
     } & {
-        realm?: string;
-    }) => Promise<{
+        realm?: string | undefined;
+    }) | undefined) => Promise<{
         id: string;
         name: string;
     }[]>;
     createAuthorizationScope: (query: {
         id: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: {
         name: string;
-        displayName?: string;
-        iconUri?: string;
+        displayName?: string | undefined;
+        iconUri?: string | undefined;
     }) => Promise<any>;
-    findPermissions: (payload?: {
+    findPermissions: (payload?: ({
         id: string;
         name: string;
     } & {
-        realm?: string;
-    }) => Promise<PolicyRepresentation[]>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<PolicyRepresentation[]>;
     createPermission: (query: {
         id: string;
         type: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: PolicyRepresentation) => Promise<PolicyRepresentation>;
     updatePermission: (query: {
         id: string;
         type: string;
         permissionId: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: PolicyRepresentation) => Promise<void>;
-    delPermission: (payload?: {
+    delPermission: (payload?: ({
         id: string;
         type: string;
         permissionId: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    findOnePermission: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    findOnePermission: (payload?: ({
         id: string;
         type: string;
         permissionId: string;
     } & {
-        realm?: string;
-    }) => Promise<PolicyRepresentation>;
-    getOfflineSessionCount: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<PolicyRepresentation | undefined>;
+    getAssociatedScopes: (payload?: ({
         id: string;
+        permissionId: string;
     } & {
-        realm?: string;
-    }) => Promise<{
+        realm?: string | undefined;
+    }) | undefined) => Promise<{
+        id: string;
+        name: string;
+    }[]>;
+    getAssociatedResources: (payload?: ({
+        id: string;
+        permissionId: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<{
+        _id: string;
+        name: string;
+    }[]>;
+    getOfflineSessionCount: (payload?: ({
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined) => Promise<{
         count: number;
     }>;
-    getInstallationProviders: (payload?: {
+    getInstallationProviders: (payload?: ({
         id: string;
         providerId: string;
     } & {
-        realm?: string;
-    }) => Promise<string>;
-    pushRevocation: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<string>;
+    pushRevocation: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<GlobalRequestResult>;
-    addClusterNode: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<GlobalRequestResult>;
+    addClusterNode: (payload?: ({
         id: string;
         node: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    deleteClusterNode: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    deleteClusterNode: (payload?: ({
         id: string;
         node: string;
     } & {
-        realm?: string;
-    }) => Promise<void>;
-    testNodesAvailable: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<void>;
+    testNodesAvailable: (payload?: ({
         id: string;
     } & {
-        realm?: string;
-    }) => Promise<GlobalRequestResult>;
-    getKeyInfo: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<GlobalRequestResult>;
+    getKeyInfo: (payload?: ({
         id: string;
         attr: string;
     } & {
-        realm?: string;
-    }) => Promise<CertificateRepresentation>;
-    generateKey: (payload?: {
+        realm?: string | undefined;
+    }) | undefined) => Promise<CertificateRepresentation>;
+    generateKey: (payload?: ({
         id: string;
         attr: string;
     } & {
-        realm?: string;
-    }) => Promise<CertificateRepresentation>;
+        realm?: string | undefined;
+    }) | undefined) => Promise<CertificateRepresentation>;
     downloadKey: (query: {
         id: string;
         attr: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: KeyStoreConfig) => Promise<string>;
     generateAndDownloadKey: (query: {
         id: string;
         attr: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: KeyStoreConfig) => Promise<string>;
     uploadKey: (query: {
         id: string;
         attr: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: any) => Promise<any>;
     uploadCertificate: (query: {
         id: string;
         attr: string;
     } & {
-        realm?: string;
+        realm?: string | undefined;
     }, payload: any) => Promise<any>;
     constructor(client: KeycloakAdminClient);
     findProtocolMapperByName(payload: {
         realm?: string;
         id: string;
         name: string;
-    }): Promise<ProtocolMapperRepresentation>;
+    }): Promise<ProtocolMapperRepresentation | undefined>;
 }