@sailpoint/api-client 2.2.11 → 2.2.13

package/dist/connectors/api.d.ts

@@ -56,6 +56,12 @@ export interface ConnectorDetail {
      * @memberof ConnectorDetail
      */
     'applicationXml'?: string;
+    /**
+     * Default provisioning policies parsed from the connector application XML templates. Always an array; empty when the connector ships no templates.
+     * @type {Array<ProvisioningPolicyDto>}
+     * @memberof ConnectorDetail
+     */
+    'provisioningPolicies'?: Array<ProvisioningPolicyDto>;
     /**
      * The connector correlation config xml
      * @type {string}
@@ -190,6 +196,58 @@ export interface ErrorResponseDto {
      */
     'causes'?: Array<ErrorMessageDto>;
 }
+/**
+ *
+ * @export
+ * @interface FieldDetailsDto
+ */
+export interface FieldDetailsDto {
+    /**
+     * The name of the attribute.
+     * @type {string}
+     * @memberof FieldDetailsDto
+     */
+    'name'?: string;
+    /**
+     * The transform to apply to the field
+     * @type {object}
+     * @memberof FieldDetailsDto
+     */
+    'transform'?: object;
+    /**
+     * Attributes required for the transform
+     * @type {object}
+     * @memberof FieldDetailsDto
+     */
+    'attributes'?: object;
+    /**
+     * Flag indicating whether or not the attribute is required.
+     * @type {boolean}
+     * @memberof FieldDetailsDto
+     */
+    'isRequired'?: boolean;
+    /**
+     * The type of the attribute.  string: For text-based data.  int: For whole numbers.  long: For larger whole numbers.  date: For date and time values.  boolean: For true/false values.  secret: For sensitive data like passwords, which will be masked and encrypted.
+     * @type {string}
+     * @memberof FieldDetailsDto
+     */
+    'type'?: FieldDetailsDtoTypeEnum;
+    /**
+     * Flag indicating whether or not the attribute is multi-valued.
+     * @type {boolean}
+     * @memberof FieldDetailsDto
+     */
+    'isMultiValued'?: boolean;
+}
+export declare const FieldDetailsDtoTypeEnum: {
+    readonly String: "string";
+    readonly Int: "int";
+    readonly Long: "long";
+    readonly Date: "date";
+    readonly Boolean: "boolean";
+    readonly Secret: "secret";
+};
+export type FieldDetailsDtoTypeEnum = typeof FieldDetailsDtoTypeEnum[keyof typeof FieldDetailsDtoTypeEnum];
 /**
  *
  * @export
@@ -266,6 +324,37 @@ export declare const LocaleOrigin: {
     readonly Request: "REQUEST";
 };
 export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin];
+/**
+ *
+ * @export
+ * @interface ProvisioningPolicyDto
+ */
+export interface ProvisioningPolicyDto {
+    /**
+     * the provisioning policy name
+     * @type {string}
+     * @memberof ProvisioningPolicyDto
+     */
+    'name': string | null;
+    /**
+     * the description of the provisioning policy
+     * @type {string}
+     * @memberof ProvisioningPolicyDto
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {UsageType}
+     * @memberof ProvisioningPolicyDto
+     */
+    'usageType'?: UsageType;
+    /**
+     *
+     * @type {Array<FieldDetailsDto>}
+     * @memberof ProvisioningPolicyDto
+     */
+    'fields'?: Array<FieldDetailsDto>;
+}
 /**
  *
  * @export
@@ -343,6 +432,30 @@ export declare const UpdateDetailStatusEnum: {
     readonly Skipped: "SKIPPED";
 };
 export type UpdateDetailStatusEnum = typeof UpdateDetailStatusEnum[keyof typeof UpdateDetailStatusEnum];
+/**
+ * The type of provisioning policy usage.  In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations.  Each usage type is considered a provisioning policy.  A source can have any number of these provisioning policies defined.  These are the common usage types:  CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.   UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created.  DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these usage types for all your provisioning policy needs.
+ * @export
+ * @enum {string}
+ */
+export declare const UsageType: {
+    readonly Create: "CREATE";
+    readonly Update: "UPDATE";
+    readonly Enable: "ENABLE";
+    readonly Disable: "DISABLE";
+    readonly Delete: "DELETE";
+    readonly Assign: "ASSIGN";
+    readonly Unassign: "UNASSIGN";
+    readonly CreateGroup: "CREATE_GROUP";
+    readonly UpdateGroup: "UPDATE_GROUP";
+    readonly DeleteGroup: "DELETE_GROUP";
+    readonly Register: "REGISTER";
+    readonly CreateIdentity: "CREATE_IDENTITY";
+    readonly UpdateIdentity: "UPDATE_IDENTITY";
+    readonly EditGroup: "EDIT_GROUP";
+    readonly Unlock: "UNLOCK";
+    readonly ChangePassword: "CHANGE_PASSWORD";
+};
+export type UsageType = typeof UsageType[keyof typeof UsageType];
 /**
  *
  * @export

package/dist/connectors/api.js

@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PutConnectorTranslationsV1LocaleEnum = exports.GetConnectorV1LocaleEnum = exports.GetConnectorTranslationsV1LocaleEnum = exports.GetConnectorListV1LocaleEnum = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.V3CreateConnectorDtoStatusEnum = exports.V3ConnectorDtoStatusEnum = exports.UpdateDetailStatusEnum = exports.LocaleOrigin = exports.JsonPatchOperationOpEnum = exports.ConnectorDetailStatusEnum = void 0;
+exports.PutConnectorTranslationsV1LocaleEnum = exports.GetConnectorV1LocaleEnum = exports.GetConnectorTranslationsV1LocaleEnum = exports.GetConnectorListV1LocaleEnum = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.V3CreateConnectorDtoStatusEnum = exports.V3ConnectorDtoStatusEnum = exports.UsageType = exports.UpdateDetailStatusEnum = exports.LocaleOrigin = exports.JsonPatchOperationOpEnum = exports.FieldDetailsDtoTypeEnum = exports.ConnectorDetailStatusEnum = void 0;
 var axios_1 = __importDefault(require("axios"));
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -91,6 +91,14 @@ exports.ConnectorDetailStatusEnum = {
     Demo: 'DEMO',
     Released: 'RELEASED'
 };
+exports.FieldDetailsDtoTypeEnum = {
+    String: 'string',
+    Int: 'int',
+    Long: 'long',
+    Date: 'date',
+    Boolean: 'boolean',
+    Secret: 'secret'
+};
 exports.JsonPatchOperationOpEnum = {
     Add: 'add',
     Remove: 'remove',
@@ -114,6 +122,29 @@ exports.UpdateDetailStatusEnum = {
     Unchanged: 'UNCHANGED',
     Skipped: 'SKIPPED'
 };
+/**
+ * The type of provisioning policy usage.  In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations.  Each usage type is considered a provisioning policy.  A source can have any number of these provisioning policies defined.  These are the common usage types:  CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.   UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created.  DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these usage types for all your provisioning policy needs.
+ * @export
+ * @enum {string}
+ */
+exports.UsageType = {
+    Create: 'CREATE',
+    Update: 'UPDATE',
+    Enable: 'ENABLE',
+    Disable: 'DISABLE',
+    Delete: 'DELETE',
+    Assign: 'ASSIGN',
+    Unassign: 'UNASSIGN',
+    CreateGroup: 'CREATE_GROUP',
+    UpdateGroup: 'UPDATE_GROUP',
+    DeleteGroup: 'DELETE_GROUP',
+    Register: 'REGISTER',
+    CreateIdentity: 'CREATE_IDENTITY',
+    UpdateIdentity: 'UPDATE_IDENTITY',
+    EditGroup: 'EDIT_GROUP',
+    Unlock: 'UNLOCK',
+    ChangePassword: 'CHANGE_PASSWORD'
+};
 exports.V3ConnectorDtoStatusEnum = {
     Deprecated: 'DEPRECATED',
     Development: 'DEVELOPMENT',