Merge pull request #1069 from atlanhq/FT-816

Adds limited ability to configure an SSO provider

Author: cmgrote

sdk/src/main/java/com/atlan/api/SSOEndpoint.java

@@ -8,6 +8,7 @@
 import com.atlan.exception.InvalidRequestException;
 import com.atlan.model.admin.AtlanGroup;
 import com.atlan.model.admin.SSOMapping;
+import com.atlan.model.admin.SSOProviderRequest;
 import com.atlan.net.ApiResource;
 import com.atlan.net.RequestOptions;
 import com.fasterxml.jackson.core.JsonGenerator;
@@ -40,6 +41,54 @@ public SSOEndpoint(AtlanClient client) {
         super(client);
     }
 
+    /**
+     * Configure an SSO provider.
+     *
+     * @param request details of the configuration for an SSO provider
+     * @throws AtlanException on any API communication issue
+     */
+    public void configure(SSOProviderRequest request) throws AtlanException {
+        configure(request, null);
+    }
+
+    /**
+     * Configure an SSO provider.
+     *
+     * @param request details of the configuration for an SSO provider
+     * @param options to override default client settings
+     * @throws AtlanException on any API communication issue
+     */
+    public void configure(SSOProviderRequest request, RequestOptions options) throws AtlanException {
+        String url = String.format("%s%s", getBaseUrl(), endpoint);
+        ApiResource.request(client, ApiResource.RequestMethod.POST, url, request, options);
+    }
+
+    /**
+     * Creates a new Atlan SSO mapping.
+     *
+     * @param ssoAlias name of the SSO provider
+     * @param mapping details of the mapping to create
+     * @return created SSO mapping
+     * @throws AtlanException on any API communication issue
+     */
+    public SSOMapping createMapping(String ssoAlias, SSOMapping mapping) throws AtlanException {
+        return createMapping(ssoAlias, mapping, null);
+    }
+
+    /**
+     * Creates a new Atlan SSO mapping.
+     *
+     * @param ssoAlias name of the SSO provider
+     * @param mapping details of the mapping to create
+     * @param options to override default client settings
+     * @return created SSO mapping
+     * @throws AtlanException on any API communication issue
+     */
+    public SSOMapping createMapping(String ssoAlias, SSOMapping mapping, RequestOptions options) throws AtlanException {
+        String url = String.format("%s%s/%s/mappers", getBaseUrl(), endpoint, ssoAlias);
+        return ApiResource.request(client, ApiResource.RequestMethod.POST, url, mapping, SSOMapping.class, options);
+    }
+
     /**
      * Retrieves all existing Atlan SSO group mappings.
      *
@@ -132,8 +181,7 @@ public SSOMapping createGroupMapping(String ssoAlias, AtlanGroup group, String s
                 .identityProviderAlias(ssoAlias)
                 .identityProviderMapper(IDP_GROUP_MAPPER)
                 .build();
-        String url = String.format("%s%s/%s/mappers", getBaseUrl(), endpoint, ssoAlias);
-        return ApiResource.request(client, ApiResource.RequestMethod.POST, url, request, SSOMapping.class, options);
+        return createMapping(ssoAlias, request, options);
     }
 
     /**

sdk/src/main/java/com/atlan/model/admin/SSOMapping.java

@@ -52,6 +52,10 @@ public static final class Config extends AtlanObject {
         @JsonProperty("group")
         String groupName;
 
+        /** Name of the user attribute. */
+        @JsonProperty("user.attribute")
+        String userAttribute;
+
         /** Name of the SSO attribute containing the mapping. */
         @JsonProperty("attribute.name")
         String attributeName;
@@ -67,5 +71,8 @@ public static final class Config extends AtlanObject {
         /** TBC */
         @JsonProperty("are.attribute.values.regex")
         String attributeValuesRegex;
+
+        /** TBC */
+        String role;
     }
 }

sdk/src/main/java/com/atlan/model/admin/SSOProviderRequest.java

@@ -0,0 +1,77 @@
+/* SPDX-License-Identifier: Apache-2.0
+   Copyright 2023 Atlan Pte. Ltd. */
+package com.atlan.model.admin;
+
+import com.atlan.model.core.AtlanObject;
+import lombok.*;
+import lombok.experimental.SuperBuilder;
+import lombok.extern.jackson.Jacksonized;
+
+@Getter
+@SuperBuilder(toBuilder = true)
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
+public class SSOProviderRequest extends AtlanObject {
+    private static final long serialVersionUID = 2L;
+
+    /** Alias for the SSO provider. */
+    String alias;
+
+    /** Type of SSO provider (for example, {@code saml}). */
+    String providerId;
+
+    /** Whether the provider should be active (true) or not (false). */
+    @Builder.Default
+    Boolean enabled = true;
+
+    /** TBC */
+    Boolean trustEmail;
+
+    /** TBC */
+    Boolean storeToken;
+
+    /** TBC */
+    Boolean addReadTokenRoleOnCreate;
+
+    /** TBC */
+    Boolean linkOnly;
+
+    /** TBC */
+    String firstBrokerLoginFlowAlias;
+
+    /** Label to show users for logging in with this provider. */
+    String displayName;
+
+    /** Configuration for the provider. */
+    Config config;
+
+    @Getter
+    @Jacksonized
+    @Builder(toBuilder = true)
+    @EqualsAndHashCode(callSuper = true)
+    @ToString(callSuper = true)
+    public static final class Config extends AtlanObject {
+        private static final long serialVersionUID = 2L;
+
+        /** TBC */
+        String nameIDPolicyFormat;
+
+        /** TBC */
+        String postBindingAuthnRequest;
+
+        /** TBC */
+        String postBindingResponse;
+
+        /** TBC */
+        String principalType;
+
+        /** TBC */
+        String syncMode;
+
+        /** TBC */
+        String singleSignOnServiceUrl;
+
+        /** TBC */
+        String signingCertificate;
+    }
+}