feat(saml): add the new resource

src/resources/PlatformResources.ts

@@ -11,6 +11,7 @@ import MachineLearning from './MachineLearning/MachineLearning';
 import Organization from './Organizations/Organization';
 import Pipelines from './Pipelines/Pipelines';
 import Resource from './Resource';
+import Saml from './Saml/Saml';
 import SecurityCache from './SecurityCache/SecurityCache';
 import Sources from './Sources/Sources';
 
@@ -28,6 +29,7 @@ const resourcesMap: Array<{key: string; resource: typeof Resource}> = [
     {key: 'pipeline', resource: Pipelines},
     {key: 'source', resource: Sources},
     {key: 'field', resource: Field},
+    {key: 'saml', resource: Saml},
 ];
 
 class PlatformResources {
@@ -46,6 +48,7 @@ class PlatformResources {
     pipeline: Pipelines;
     source: Sources;
     field: Field;
+    saml: Saml;
 
     registerAll() {
         resourcesMap.forEach(({key, resource}) => {

src/resources/Saml/Saml.ts

@@ -0,0 +1,37 @@
+import API from '../../APICore';
+import {New} from '../BaseInterfaces';
+import {RealmModel} from '../Groups';
+import Resource from '../Resource';
+import {SamlIdentityProviderEnabledModel, SamlIdentityProviderModel} from './SamlInterfaces';
+
+export default class Saml extends Resource {
+    static baseUrl = `/rest/organizations/${API.orgPlaceholder}/saml`;
+
+    isEnabled() {
+        return this.api.get<SamlIdentityProviderEnabledModel>(`${Saml.baseUrl}/enabled`);
+    }
+
+    listAvailableProviders() {
+        return this.api.get<SamlIdentityProviderModel[]>(`${Saml.baseUrl}/availables`);
+    }
+
+    deleteProvider() {
+        return this.api.delete(`${Saml.baseUrl}/identityProvider`);
+    }
+
+    getProvider() {
+        return this.api.get<SamlIdentityProviderModel>(`${Saml.baseUrl}/identityProvider`);
+    }
+
+    create(identityProvider: New<SamlIdentityProviderModel>) {
+        return this.api.post<SamlIdentityProviderModel>(`${Saml.baseUrl}/identityProvider`, identityProvider);
+    }
+
+    update(identityProvider: SamlIdentityProviderModel) {
+        return this.api.put<SamlIdentityProviderModel>(`${Saml.baseUrl}/identityProvider`, identityProvider);
+    }
+
+    listRealms() {
+        return this.api.get<RealmModel[]>(`${Saml.baseUrl}/identityProvider/realms`);
+    }
+}

src/resources/Saml/SamlInterfaces.ts

@@ -0,0 +1,15 @@
+import {IdAndDisplayNameModel} from '../BaseInterfaces';
+
+export interface SamlIdentityProviderEnabledModel {
+    organizationId: string;
+    samlEnabled: boolean;
+}
+
+export interface SamlIdentityProviderModel {
+    displayName: string;
+    entityId: string;
+    id: string;
+    organizationIds: IdAndDisplayNameModel[];
+    postBindingEndpoint: string;
+    x509Certificate: string;
+}

src/resources/Saml/index.ts

@@ -0,0 +1,2 @@
+export * from './Saml';
+export * from './SamlInterfaces';

src/resources/Saml/tests/Saml.spec.ts

@@ -0,0 +1,97 @@
+import API from '../../../APICore';
+import {New} from '../../BaseInterfaces';
+import Saml from '../Saml';
+import {SamlIdentityProviderModel} from '../SamlInterfaces';
+
+jest.mock('../../../APICore');
+
+const APIMock: jest.Mock<API> = API as any;
+
+describe('Saml', () => {
+    let saml: Saml;
+    const api = new APIMock() as jest.Mocked<API>;
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        saml = new Saml(api);
+    });
+
+    describe('isEnabled', () => {
+        it('should make a GET call to "/saml/enabled"', () => {
+            saml.isEnabled();
+            expect(api.get).toHaveBeenCalledTimes(1);
+            expect(api.get).toHaveBeenCalledWith('/rest/organizations/{organizationName}/saml/enabled');
+        });
+    });
+
+    describe('listAvailableProviders', () => {
+        it('should make a GET call to "/saml/availables"', () => {
+            saml.listAvailableProviders();
+            expect(api.get).toHaveBeenCalledTimes(1);
+            expect(api.get).toHaveBeenCalledWith('/rest/organizations/{organizationName}/saml/availables');
+        });
+    });
+
+    describe('getProvider', () => {
+        it('should make a GET call to "/saml/identityProvider"', () => {
+            saml.getProvider();
+            expect(api.get).toHaveBeenCalledTimes(1);
+            expect(api.get).toHaveBeenCalledWith('/rest/organizations/{organizationName}/saml/identityProvider');
+        });
+    });
+
+    describe('listRealms', () => {
+        it('should make a GET call to "/saml/identityProvider/realms"', () => {
+            saml.listRealms();
+            expect(api.get).toHaveBeenCalledTimes(1);
+            expect(api.get).toHaveBeenCalledWith('/rest/organizations/{organizationName}/saml/identityProvider/realms');
+        });
+    });
+
+    describe('deleteProvdier', () => {
+        it('should make a DELETE call to "/saml/identityProvider"', () => {
+            saml.deleteProvider();
+            expect(api.delete).toHaveBeenCalledTimes(1);
+            expect(api.delete).toHaveBeenCalledWith('/rest/organizations/{organizationName}/saml/identityProvider');
+        });
+    });
+
+    describe('create', () => {
+        it('should make a POST call to "/saml/identityProvider"', () => {
+            const provider: New<SamlIdentityProviderModel> = {
+                displayName: 'My SAML SSO',
+                entityId: 'whatever',
+                organizationIds: [{id: 'org-1'}, {id: 'org-2'}],
+                postBindingEndpoint: 'the-saml-endpoint',
+                x509Certificate: 'my-certificate',
+            };
+
+            saml.create(provider);
+            expect(api.post).toHaveBeenCalledTimes(1);
+            expect(api.post).toHaveBeenCalledWith(
+                '/rest/organizations/{organizationName}/saml/identityProvider',
+                provider
+            );
+        });
+    });
+
+    describe('update', () => {
+        it('should make a PUT call to "/saml/identityProvider"', () => {
+            const provider: SamlIdentityProviderModel = {
+                id: '123-abc',
+                displayName: 'My SAML SSO',
+                entityId: 'whatever',
+                organizationIds: [{id: 'org-1'}, {id: 'org-2'}],
+                postBindingEndpoint: 'the-saml-endpoint',
+                x509Certificate: 'my-certificate',
+            };
+
+            saml.update(provider);
+            expect(api.put).toHaveBeenCalledTimes(1);
+            expect(api.put).toHaveBeenCalledWith(
+                '/rest/organizations/{organizationName}/saml/identityProvider',
+                provider
+            );
+        });
+    });
+});

src/resources/index.ts

@@ -15,3 +15,4 @@ export * from './MachineLearning';
 export * from './Pipelines';
 export * from './Sources';
 export * from './Fields';
+export * from './Saml';

src/resources/tests/PlatformResources.spec.ts

@@ -9,6 +9,7 @@ import MachineLearning from '../MachineLearning/MachineLearning';
 import Organization from '../Organizations/Organization';
 import Pipelines from '../Pipelines/Pipelines';
 import PlatformResources from '../PlatformResources';
+import Saml from '../Saml/Saml';
 import SecurityCache from '../SecurityCache/SecurityCache';
 import Sources from '../Sources/Sources';
 
@@ -109,5 +110,13 @@ describe('PlatformResources', () => {
             expect(platformResources.field).toBeDefined();
             expect(platformResources.field).toBeInstanceOf(Field);
         });
+
+        it('should register the saml resource on the platform instance', () => {
+            const platformResources = new PlatformResources();
+            platformResources.registerAll();
+
+            expect(platformResources.saml).toBeDefined();
+            expect(platformResources.saml).toBeInstanceOf(Saml);
+        });
     });
 });